一.依赖文件
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.2.0</version>
</dependency>
二.配置类
这里注意上面的地址根据自己接口地址填就好。
三.常用注解
1.@Tag
用于标识controller,例如
2.@Operation
用于标识方法,例如
3.@Schema
用于标识实体类和属性,例如
四.访问SwaggerUI界面
启动工程后,通过 http://主机地址:端口地址/swagger-ui/index.html来访问界面。
页面效果如下:
五.进行接口测试
首先点击 Try it out
然后填好相关参数后点击Execute执行即可