Swagger-的使用
- 前言
- 效果
- 1、相关依赖
- 2、相关注解
- 2.1 @Tag设置整个类的名称和详情
- 2.2 @Operation描述具体的方法
- 2.3 @Parameter 描述参数
- 2.4@Schema 为属性添加注释
- 3、Docket配置
- 3.1通过gropeediopenapi进行分组
- 3.2 通过docsOpenApi设置
前言
在我们和前端进行交互的时候，出接口文档是一件必须的事情，如果手写接口文档是一件很折磨人的事情，不管是前端还是后端开发，多多少少都会被接口文档所折磨，前端会抱怨后端没有及时更新接口文档，而后端又会觉得编写接口文档太过麻烦。通过swagger可以很好的解决这个问题
效果
1、相关依赖
<!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.3.0</version>
</dependency>
2、相关注解
2.1 @Tag设置整个类的名称和详情
2.2 @Operation描述具体的方法
2.3 @Parameter 描述参数
2.4@Schema 为属性添加注释
3、Docket配置
3.1通过gropeediopenapi进行分组
3.2 通过docsOpenApi设置
