RuoYi-Vue-Plus框架接口文档使用

版本 >= 4.3.0

说明

由于 springfox 与 knife4j 均停止维护 bug众多
故从 4.3.0 开始 迁移到 springdoc 框架
基于 javadoc 无注解零入侵生成规范的 openapi 结构体
由于框架自带文档UI功能单一扩展性差 故移除自带UI 建议使用外置文档工具

文档工具使用

由于框架采用 openapi 行业规范 故市面上大部分的框架均支持 可自行选择
例如: apifox apipost postman torna knife4j 等 根据对应工具的文档接入即可

Apifox

1.下载或使用web在线版 创建一个自己的项目

2.进入项目 选择项目设置 找到自动同步

3.根据项目内所有文档组完成所有数据源创建(拉取后端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/3.代码生成模块
也可不分组统一导入: http://localhost:8080/v3/api-docs

4.选择 接口管理 项目概览 点击立即导入 并等待导入完成

后续会根据策略每3个小时自动导入一次
每次重新进入apifox也会自动同步一次
后端有改动也可以手动点击导入

5.(注意版本号)设置鉴权 选择管理环境 按照如下配置

key对应项目配置 默认为 Authorization

6、效果展示