Spring Boot 整合 Knife4j 接口文档

Spring Boot 整合 Knife4j 接口文档

首先，什么是接口文档？写接口信息的文档，每条接口包括：

• 请求参数

• 响应参数

  • 错误码

• 接口地址

• 接口名称

• 请求类型

• 请求格式

• 备注

who 谁用？

一搬是后端或者负责人来提供，后端和前端都要使用

为什么需要接口文档？

• 有个书面内容（背书或者归档），便于大家参考和查阅，便于沉淀和维护，拒绝口口相传

• 接口文档便于前端和后端开发对接，前后端联调的介质。后端 => 接口文档 <= 前端

• 好的接口文档支持在线调试、在线测试，可以作为工具提高我们的开发测试效率

怎么做接口文档？

• 手写（比如腾讯文档、Markdown笔记）

• 自动化接口文档生成：自动根据项目代码生成完整的文档或在线调试的网页。Swagger，Postman（侧重接口管理）（国外）； apifox、apipost、eolink（国产）

开始整合

 1. 引用依赖 Knife4j官网，根据 Springboot 版本选择不同的引用方式

如果不知道自己的Springboot是什么版本的，可以打开项目中的pom.xml文件中看

 作者这里的版本是2.6以上，故使用以下的引用：

将依赖加到pom.xml中

点击引用依赖

 2. 配置yml属性（这里也是要根据自己的版本来选择对应的yml属性）：

knife4j:
  enable: true
  openapi:
    title: Knife4j官方文档
    description: "`我是测试`,**你知道吗**
    # aaa"
    email: xiaoymin@foxmail.com
    concat: 八一菜刀
    url: https://docs.xiaominfo.com
    version: v4.0
    license: Apache 2.0
    license-url: https://stackoverflow.com/
    terms-of-service-url: https://stackoverflow.com/
    group:
      test1:
        group-name: 分组名称
        api-rule: package
        api-rule-resources:
          - com.knife4j.demo.new3

注意要修改 api-rule-resources

选择接口所在的包，右击复制路径：

3. 配置完后重启app。

4. 最后，访问Knife4j的文档地址：http://ip:port/doc.html即可查看文档

最后的最后还是得说一句，配置api主要根据官方文档的说明进行配置，毕竟技术会更新迭代，dddd~