简介

接口文档使用的是SpringDoc (opens new window)

使用

可以不在Controller里写任何注解，可以自动识别

也可以手动写一些文字描述

在Controller类上可写@Tag(name = "功能测试", description = "对系统内的一些功能进行测试和展示使用方法")

在方法上可以写@Operation(method = "肯定是GET啦", summary = "获取数据源一的数据", description = "我是description")

开关

在application-dev/prod.yml里

springdoc节点下

可以添加和修改数据源

在线文档

项目启动后，访问 http://127.0.0.1:8033/my/swagger-ui.html 即可看到在线文档

生产环境慎重开启

导入到第三方API管理工具

例如ApiFox

首先确保可以访问http://127.0.0.1:8033/my/api-docs

其中的/api-docs，可以在springdoc配置修改

打开ApiFox 一路点确定即可