SpringBoot 整合 Knife4j

墨尘 2022年02月11日 10:08 229 0

1、引入依赖
<>
    <>com.github.xiaoymin</>
    <>knife4j-spring-boot-starter</>
    <>3.0.3</>
</>

2、在配置类上加入@EnableOpenApi 注解，开启 Knife4j 增强功能。

@EnableOpenApi

3、重启项目，访问API文档

如果项目中加了权限认证的话，记得给 Knife4j 添加白名单。我的项目用的是 SpringSecurity，所以需要在 application.yml 文件中添加。

secure:
ignored:
urls: #- /doc.html
    - /swagger-uiv3/api-docs

1）支持登录认证

Knife4j 和 Swagger 一样，也是支持头部登录认证的，点击「authorize」菜单，添加登录后的信息即可保持登录认证的 token。

如果某个 API 需要登录认证的话，就会把之前填写的信息带过来。

2）支持 JSON 折叠

Swagger 是不支持 JSON 折叠的，当返回的信息非常多的时候，界面就会显得非常的臃肿。Knife4j 则不同，可以对返回的 JSON 节点进行折叠。

3）离线文档

Knife4j 支持把 API 文档导出为离线文档（支持 markdown 格式、HTML 格式、Word 格式），

4）全局参数

当某些请求需要全局参数时，这个功能就很实用了，Knife4j 支持 header 和 query 两种方式。

之后进行请求的时候，就会把这个全局参数带过去。

5）搜索 API 接口

Swagger 是没有搜索功能的，当要测试的接口有很多的时候，当需要去找某一个 API 的时候就傻眼了，只能一个个去拖动滚动条去找。

除了我上面提到的增强功能，Knife4j 还提供了很多实用的功能，大家可以通过官网的介绍一一尝试下，生产效率会提高不少。

如果项目中之前使用过 Swagger 生成接口文档，切换到 Knife4j 可以说是非常的丝滑，只需要两步：

在 pom.xml 文件中把 springfox-boot-starter 替换为 knife4j-spring-boot-starter；
访问地址由原来的 http://${host}:${port}/swagger-ui.html 切换到 http://${host}:${port}/doc.html，如果有权限限制的话，记得开白名单。

标签： #Java #Knife4j