接口文档
说明
说明
- 由于 springfox 与 knife4j 均停止维护 bug众多
- 选用 springdoc 框架
- 基于 javadoc 无注解零入侵生成规范的 openapi 结构体
- 由于框架自带文档UI功能单一扩展性差 故移除自带UI 建议使用外置文档工具
文档工具使用
- 由于框架采用 openapi 行业规范 故市面上大部分的框架均支持 可自行选择
- 例如: apifox apipost postman torna knife4j 等 根据对应工具的文档接入即可
官网连接: https://www.apifox.cn/
- 推荐下载客户端软件
- 注册/登录软件后进行下面操作
方式一（推荐）
TIP
- 优点：灵活对某一个类进行提交更新接口
- 缺点：非自动
- IDEA 安装插件
- 获取 Token
- 测试链接
- 上传到 ApiFox
- 效果
方式二
TIP
- 优点：利用 Apifox 的导入工具，可以自动定时获取数据
- 缺点：自动刷新周期过长，不能实时刷新
- 根据项目内所有文档组完成所有数据源创建(拉取后端openapi结构体)
- 数据源URL格式
http://后端ip:端口/v3/api-docs/组名
项目内所需:
http://localhost:8080/v3/api-docs/1.演示模块
http://localhost:8080/v3/api-docs/2.系统模块
也可不分组统一导入: http://localhost:8080/v3/api-docs
操作如下图：
分享文档
创建分享
