Springboot+swagger+apifox
一、前提准备。
已经创建好了基本的包目录
下面详细步骤:
一、引入swagger依赖
<!-- swagger3-openapi依赖包 -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.11</version>
<exclusions>
<exclusion>
<artifactId>swagger-ui</artifactId>
<groupId>org.webjars</groupId>
</exclusion>
</exclusions>
</dependency>
二、分别在controller类上面,方法上面,参数加swagger对应注解注解:
// 作用在controller类上面,指定目录
@Tag(name = "学校模块/学生管理")
// 作用在controller方法上面,说明方法作用
@Operation(summary = "查询所有学生")
// 作用在controller方法参数里面,说明参数
@Parameter(name = "id", description = "学生id", required = true)
// 作用在入参或出参类的属性上面,说明属性的含义
@Schema(description = "学生id")
三、启动项目
四、使用apifox手动添加接口,访问地址:http://127.0.0.1:8080/v3/api-docs
输入地址:http://127.0.0.1:8080/v3/api-docs,点击提交
然后点击确认导入
五‘导入成功