当前位置：首页 > news >正文

swagger快速入门

news 来源：原创 2025/4/27 11:29:17

swagger帮助后端生成接口文档，以及在线接口测试

Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

使用方法

一，导入knife4j的maven坐标

<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.2</version>
</dependency>

二，在配置类中加入 knife4j相关配置

    @Beanpublic Docket docket() {log.info("开始生成接口文档");//构建文档信息ApiInfo apiInfo = new ApiInfoBuilder().title("项目接口文档标题").version("接口文档版本").description("项目接口文档描述信息").build();//创建对象并且指定swagger版本Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo)    //指定配置.select()//最重要的一句，指定生成接口文档要扫描的包.apis(RequestHandlerSelectors.basePackage("com.xxxx.controller")).paths(PathSelectors.any()).build();return docket;}

三，配置类里设置静态资源映射，否则接口文档页面无法访问

    //设置静态资源映射//代码固定，不用修改protected void addResourceHandlers(ResourceHandlerRegistry registry) {log.info("开始设置静态资源映射");registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}

访问地址：localhost:8080/doc.html#/home