接口文档

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

文档工具使用

由于框架采用 openapi 行业规范故市面上大部分的框架均支持可自行选择

例如: apifox apipost postman torna knife4j 等根据对应工具的文档接入即可

Swagger升级SpringDoc指南

常见功能如下其他功能自行挖掘

注意: javadoc 只能替换基础功能特殊功能还需要使用注解实现

swagger	springdoc	javadoc
@Api(name = "xxx")	@Tag(name = "xxx")	java类注释第一行
@Api(description= "xxx")	@Tag(description= "xxx")	java类注释
@ApiOperation	@Operation	java方法注释
@ApiIgnore	@Hidden	无
@ApiParam	@Parameter	java方法@param参数注释
@ApiImplicitParam	@Parameter	java方法@param参数注释
@ApiImplicitParams	@Parameters	多个@param参数注释
@ApiModel	@Schema	java实体类注释
@ApiModelProperty	@Schema	java属性注释
@ApiModelProperty(hidden = true)	@Schema(accessMode = READ_ONLY)	无
@ApiResponse	@ApiResponse	java方法@return返回值注释

建议使用 `Apifox`(常见问题有其他对接方式)

官网连接: https://www.apifox.cn/

视频教程: springdoc与apifox配合使用

输入图片说明

支持文档编写接口调试 Mock 接口压测自动化测试等一系列功能

接入框架

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

输入图片说明

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

输入图片说明

3.根据项目内所有文档组完成所有数据源创建(拉取后端openapi结构体)

数据源URL格式 http://网关ip:端口/服务路径/v3/api-docs

项目内所需:

http://localhost:8080/demo/v3/api-docs 演示服务

http://localhost:8080/auth/v3/api-docs 认证服务

http://localhost:8080/resource/v3/api-docs 资源服务

http://localhost:8080/system/v3/api-docs 系统服务

http://localhost:8080/code/v3/api-docs 代码生成服务