Springboot 整合Swagger3 和 Knife4j

前后端分离的项目，接口文档的存在十分重要。与手动编写接口文档不同，swagger是一个自动生成接口文档的工具，在需求不断变更的环境下，手动编写文档的效率实在太低。与swagger2相比新版的swagger3配置更少，使用更加方便。
而Knife4j 可以看成是Swagger 的增强版，是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍(官方文档)

接下来就开始整合，本文中采用目前最新的版本。Knife4j 已经集成了Swagger3 ，所以在整合时可以只导入Knife4j 包就行

1. 导入jar包，jar包根据需要二选一

<!-- knife4j -->
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.3</version>
</dependency><!-- swagger3 -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version>
</dependency>

2. 编写配置，并开启swagger和knife4j(如果导入了knife4j)，下面的代码进行了分组管理，其他的配置可以参考之前写的swagger2的文章(传送门)

@Configuration
@EnableOpenApi // 开始swagger
@EnableKnife4j // 开启knife4j
public class Swagger3Config {@Beanpublic Docket systemDocket() {return new Docket(DocumentationType.OAS_30).groupName("系统管理").apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.huaxiaozhuo.admin.modules.sys.controller")).paths(PathSelectors.any()).build();}@Beanpublic Docket monitorDocket() {return new Docket(DocumentationType.OAS_30).groupName("系统监控").apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.huaxiaozhuo.admin.modules.monitor.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("華小灼管理系统swagger文档").description("華小灼管理系统swagger文档").version("1.0.0").contact(new Contact("華小灼GITEE", "https://gitee.com/peachtec", "18482133793@163.com")).termsOfServiceUrl("https://blog.csdn.net/weixin_45481406").build();}
}

3. 简单的介绍相关的注解

@Api：用在请求的类上，表示对类的说明tags="说明该类的作用，可以在UI界面上看到的注解"value="该参数没什么意义，在UI界面上也看到，所以不需要配置"@ApiOperation：用在请求的方法上，说明方法的用途、作用value="说明方法的用途、作用"notes="方法的备注说明"@ApiImplicitParams：用在请求的方法上，表示一组参数说明@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面name：参数名value：参数的汉字说明、解释required：参数是否必须传paramType：参数放在哪个地方· header --> 请求参数的获取：@RequestHeader· query --> 请求参数的获取：@RequestParam· path（用于restful接口）--> 请求参数的获取：@PathVariable· div（不常用）· form（不常用）    dataType：参数类型，默认String，其它值dataType="Integer"       defaultValue：参数的默认值@ApiResponses：用在请求的方法上，表示一组响应@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息code：数字，例如400message：信息，例如"请求参数没填好"response：抛出异常的类@ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）@ApiModelProperty：用在属性上，描述响应类的属性

4. 控制类配置

@Api(tags = "系统日志")
@RequestMapping("/sys/log")
@RestController
public class SysLogController {@Autowiredprivate ISysLogService logService;@ApiOperation(value = "查询日志")@GetMapping("/list")public R list(@RequestParam Map<String, Object> params) {return R.ok().put(logService.listSysLog(params));}
}

5. 还可以对请求传递的参数类进行配置

@Data
@ApiModel(value = "登录表单")
public class UserLoginVo implements Serializable {@ApiModelProperty(value = "用户名")private String username;@ApiModelProperty(value = "密码")private String password;@ApiModelProperty(value = "图片验证码")private String captcha;@ApiModelProperty(value = "图片验证码键")private String captchaKey;
}

6. 配置完成后，访问swagger3的界面，访问地址：http://localhost:8001/swagger-ui/index.html

7. 如果配置了Knife4j，访问地址：http://localhost:8001/doc.html

8. 如果项目中配置了Shiro，需要在Shiro配置中对相关资源进行放行

Map<String, String> filterMap = new LinkedHashMap<>();
// swagger3
filterMap.put("/swagger-ui/**", "anon");
filterMap.put("/v3/**", "anon");
filterMap.put("/swagger-resources/**", "anon");
// knife4j
filterMap.put("/doc.html", "anon");
filterMap.put("/webjars/**", "anon");
shiroFilter.setFilterChainDefinitionMap(filterMap);

项目源码已放在码云上，访问地址：https://gitee.com/peachtec/huaxiaozhuo-admin

看到这里确定不点个赞再走吗。。。

Springboot 整合Swagger3 和 Knife4j相关推荐

SpringBoot 整合swagger3.X
SpringBoot 整合swagger3.X 1. 引入依赖 2. swagger配置 3. 启动程序访问 4. 集成增强文档knife4j 4.1 添加依赖 4.2 swagger配置类添加@En ...
Spring Boot整合Swagger3、Knife4j
Swagger在配置类中写法启动项目直接访问 ip:端口号/路径比如: Swagge在线接口文档访问路径: ip:端口号/swagger-ui/index.html Knife4j在线接口文档访问 ...
springboot集成swagger3与knife4j
springboot集成swagger3 swagger3的springboot启动器jar包 <!-- https://mvnrepository.com/artifact/io.spring ...
Spring Boot整合Swagger3配置全局Token
应用背景:Swagger配置全局Token的目的在于调用真正接口前会被相关拦截器拦截,拦截器会校验此次访问是否合法,这时配置全局Token的作用就显现出来了,全局Token可以存储所有接口访问时的令牌 ...
Spring Boot整合Swagger3注解@ApiImplicitParam的paramType属性为“path“
Spring Boot整合Swagger3的依赖版本为:  <dependency><groupId> ...
Spring Boot整合Swagger3注解@ApiImplicitParam的allowMultiple属性
Spring Boot整合Swagger3的依赖版本为:  <dependency><groupId> ...
Spring Boot整合Swagger3
第一步:引入SpringBoot整合Swagger2的最版版本3.0.0,目前的更新时间为2020年7月  <depe ...
SpringBoot 整合 knife4j
文章目录简述 2. 导入依赖 3. 创建配置类 4. 创建User实体类 5. 创建开发接口 6. 启动项目简述 Swagger是一款测试文档Api接口,具体用法见SpringBoot整合Swag ...
SpringBoot 集成Swagger3+knife4j
SpringBoot 集成Swagger3+knife4j 以下代码来自本人真实企业项目摘录 1. 导入SpringFox依赖 <dependenc ...

Springboot 整合Swagger3 和 Knife4j

Springboot 整合Swagger3 和 Knife4j相关推荐

最新文章

热门文章