1、引入依赖 <> <>com.github.xiaoymin</> <>knife4j-spring-boot-starter</> <>3.0.3</> </>
2、在配置类上加入@EnableOpenApi 注解,开启 Knife4j 增强功能。
@EnableOpenApi
3、重启项目,访问API文档
http://localhost:9002/doc.html
如果项目中加了权限认证的话,记得给 Knife4j 添加白名单。我的项目用的是 SpringSecurity,所以需要在 application.yml 文件中添加。
secure: ignored: urls: #- /doc.html - /swagger-uiv3/api-docs
Knife4j 的功能特点
1)支持登录认证
Knife4j 和 Swagger 一样,也是支持头部登录认证的,点击「authorize」菜单,添加登录后的信息即可保持登录认证的 token。
如果某个 API 需要登录认证的话,就会把之前填写的信息带过来。
2)支持 JSON 折叠
Swagger 是不支持 JSON 折叠的,当返回的信息非常多的时候,界面就会显得非常的臃肿。Knife4j 则不同,可以对返回的 JSON 节点进行折叠。
之后进行请求的时候,就会把这个全局参数带过去。
5)搜索 API 接口
尾声
https://doc.xiaominfo.com/knife4j/documentation/enhance.html
在 pom.xml 文件中把 springfox-boot-starter
替换为knife4j-spring-boot-starter
;访问地址由原来的 http://${host}:${port}/swagger-ui.html
切换到http://${host}:${port}/doc.html
,如果有权限限制的话,记得开白名单。
评论列表