【金秋打卡】第20天 Swagger接口文档神器 03

课程信息：

- 课程名称：Swagger接口文档神器

- 章节名称：第三章 Swagger实战 3-1 Swagger注解

- 讲师姓名：晴天哥

课程内容：

 1. Swagger整体注解：

• Swagger2请求类注解

• Swagger2请求方法注解

• Swagger对象类注解

2. Swagger2请求类注解

• @API表示Swagger识别的类

• @API放在@Controller注解并列的请求类

• 核心参数包括value、tags、descripion

3. Swagger2请求方法注解

• @ApiOperation标识Swagger识别的方法

• @ApiImplicitParam表示方法的参数说明

• @ApiResponse标识方法返回值的说明

4. Swagger2对象类的注解

• @ApiModel标识Swagger识别的JavaBeen

• @ApiModel放在JavaBeen的类定义上

• @ApiModelProperty表示JavaBeen的属性

5. Controller封装

• Controller的方法必须明确指定请求类型

• 确少请求类型的情况下列出所有请求类型

6. 生产环境控制

• Swagger在生产环境不能对外暴露

• 通过@Profile({"dev", "prod", "test"})指定环境

通过上面方法在IDEA中来指定环境

7. 默认访问地址

• 默认的访问地址需要携带默认访问路径

• 通过server.contestPath指定默认访问路径

8. Swagger权限控制

• Swagger2登录安全认证

• Swagger2 BasicAuth身份认证

• Swagger2 ApiKey身份认证

9. Swagger多环境控制

• 代码部署环境区分开发测试线上

• 基于安全靠量线上禁用Swagger

• 通过多种配置方式支持多环境配置

学习心得：

本次学习我了解了Springboot整合Swagger的整体方法，收获非常大，Swagger是一种非常好的工具。

课程截图：