SpringBoot(九) - Swagger

1、依赖

1. <dependency>
2.     <groupId>io.springfox</groupId>
3.     <artifactId>springfox-swagger2</artifactId>
4.     <version>2.8.0</version>
5. </dependency>

复制代码

2、核心启动类的注解

1. @EnableSwagger2  //启用 Swagger
2. @EnableSwaggerBootstrapUI //启用 BootstrapUI
3. //经过测试 只添加 @EnableSwagger2 就可以 (如果不可以再添加试试)

复制代码

3、Swagger 的 注解解释

3.1 实体上的注解

1. //模型数据对应的 实体注解
2. @ApiMode(value = "",description = "")
4. //模型数据对应的 属性注解
5. @ApiModelProperty(value = "")  

复制代码

3.2 controller上的注解

1. //写在controller上面，用于描述当前处理类支持的主要功能，包括版本说明
2. @Api(tags = "")
4. //写在目标请求处理方法上，用户描述当前方法支持的功能，属性value-方法的概述描述，属性notes-方法的详细描述
5. @ApiOperation(value = "",notes = "")
7. //参数说明注解，将接口的所有参数说明，进行归类，避免多个参数@ApiParam
8. @ApiImplicitParams(
9.     @ApiImplicitParam(required = false,name = "",value = "")
10. )
12. //响应码和响应说明
13. @ApiResponses({
14.     @ApiResponse(code = 201,message = "参数为空"),
15.     @ApiResponse(code = 202,message = "参数非法")
16. })
18. //参数说明注解
19. @RequestParam(value = "",required = false)

复制代码

4、UI界面

4.1 ui 依赖

1. <dependency>
2.     <groupId>io.springfox</groupId>
3.     <artifactId>springfox-swagger-ui</artifactId>
4.     <version>2.8.0</version>
5. </dependency>
8. <dependency>
9.     <groupId>com.github.xiaoymin</groupId>
10.     <artifactId>swagger-bootstrap-ui</artifactId>
11.     <version>1.9.3</version>
12. </dependency>
15. <dependency>
16.     <groupId>com.github.caspar-chen</groupId>
17.     <artifactId>swagger-ui-layer</artifactId>
18.     <version>1.1.3</version>
19. </dependency>
22. <dependency>
23.     <groupId>com.zyplayer</groupId>
24.     <artifactId>swagger-mg-ui</artifactId>
25.     <version>1.0.6</version>
26. </dependency>

复制代码

4.2 UI页面的展示

4.2.1 swagger 官方UI页面


4.2.2 bootstrap 的UI页面



免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！