spring boot 整合 swagger
- 1. swagger 简介
- 2. 创建
- 3. 配置
- 4. 配置数据源
- 5. 枚举
- 6. 枚举映射
- 7. 实体
- 8. dao
- 9. service
- 10. controller
- 11. 配置日志级别
- 12. dao 测试
- 13. service测试
- 14. controller测试
- 15. swagger2注解
- 16. 启动
git地址
https://github.com/a18792721831/studySpringCloud.git
1. swagger 简介
Swagger，中文“拽”的意思，它是一个功能强大的在线 API文档的框架，目前它的版本
为2.x，所以称为 Swagger2。Swagger2提供了在线文档的查阅和测试功能。利用 Swagger2很容易构建RESTful 风格的API，在Spring Boot 中集成 Swagger2。
2. 创建
引入依赖
implementation ‘io.springfox:springfox-swagger2:2.6.1’
implementation ‘io.springfox:springfox-swagger-ui:2.6.1’
3. 配置
4. 配置数据源
首先增加编码集依赖
implementation ‘cn.easyproject:orai18n:12.1.0.2.0’
然后配置数据源
5. 枚举
6. 枚举映射
7. 实体
8. dao
9. service
10. controller
11. 配置日志级别
logging:
level:
org:
springframework:
web:
servlet:
mvc:
method:
annotation:
RequestMappingHandlerMapping: trace
12. dao 测试
13. service测试
14. controller测试
15. swagger2注解
（3）写生成文档的注解
Swagger2通过注解来生成API接口文档，文档信息包括接口名、请求方法、参数、返回信息
等。通常情况下用于生成在线API文档，以下的注解能够满足基本需求，注解及其描述如下。
- @Api：修饰整个类，用于描述 Controller类。
- @ApiOperation：描述类的方法，或者说一个接口。
- @ApiParam:单个参数描述。
- @ApiModel：用对象来接收参数。
- @ApiProperty：用对象接收参数时，描述对象的一个字段。
- @ApiResponse：HTTP响应的一个描述。
- @ApiResponses：HTTP响应的整体描述。
- @Apilgnore：使用该注解，表示Swagger2忽略这个API。
- @ApiError：发生错误返回的信息。
- @ApiParamImplicit：一个请求参数。
- @ApiParamsImplicit：多个请求参数。