SpringBoot - Swagger (API文档实时更新工具)

阅读目录(Content)

• 总结
• 1. 背景
• 1.1 前后端分离式时代
• 1.2 产生的问题
• 1.3 解决方案
• 2. Swagger背景
• 3. 【重点】SpringBoot集成Swagger，怎么配置Swagger
• 4. Swagger UI自定义配置
• 4.1 自定义左上角“Swagger信息”模块
• 4.2 自定义右上角“分组”模块
• 4.3 底部“实体类信息”模块
• 4.3.1 如何在该模块显示一个实体类Model?
• 4.3.2 如何给实体类加注释？
• 4.3.3 如何给Controller加注释？
• 5. Swagger配置扫描接口
• 6. 模拟前端测试接口（重要）
• 面试题：如何让开发环境使用swagger，而生产环境禁用?

回到顶部(go to top)

总结

• 创建SpringBoot项目,导入Swagger依赖
  • Swagger2
  • Swagger-ui
• 创建Swagger配置类
  • 添加@Configuration注解,标识配置类
  • 添加@EnableSwagger2注解开启Swagger
• 配置Swagger的Docket的Bean实例
• 配置Swagger信息

 

 

回到顶部(go to top)

1. 背景

1.1 前后端分离式时代

 

前端项目会持有很多“假”数据，这些“假”数据应该通过后端从数据库查询而来。

然而在前后端分离时代，前端只需要知道数据的格式即可，后端只需要按需提供接口（接口产生出对应格式的数据即可）。

 

 

1.2 产生的问题

 

1.3 解决方案

早些年：用word

如今：用Swagger， Api文档与API定义同步更新

 

回到顶部(go to top)

2. Swagger背景

 

 

回到顶部(go to top)

3. 【重点】SpringBoot集成Swagger，怎么配置Swagger

• 创建SpringBoot项目,导入Swagger依赖
  • Swagger2
  • Swagger-ui
• 创建Swagger配置类
  • 添加@Configuration注解,标识配置类
  • 添加@EnableSwagger2注解开启Swagger
• 配置Swagger的Docket的Bean实例
• 配置Swagger信息

 

 

 

怎么配置swagger2？

黄色的注解都需要（@Bean那里是非必要的，只是新建了一个Docket，对应于swagger UI上的一个新分组。没有新Docket，所有信息会显示到默认分组default中）

 

 

 

 

 该html界面位置在：

 

 

回到顶部(go to top)

4. Swagger UI自定义配置

4.1 自定义左上角“Swagger信息”模块

 

 

 

4.2 自定义右上角“分组”模块

 

向ioc容器中，注册多个Docket bean即可：

 

 

4.3 底部“实体类信息”模块

4.3.1 如何在该模块显示一个实体类Model?

 

 

4.3.2 如何给实体类加注释？

 

 

 

4.3.3 如何给Controller加注释？

 

 

 

 

 

 

 

回到顶部(go to top)

5. Swagger配置扫描接口

 

 

回到顶部(go to top)

6. 模拟前端测试接口（重要）

 

 

 

 

 

 

 

 

 

回到顶部(go to top)

面试题：如何让开发环境使用swagger，而生产环境禁用?

前提：项目中需要有多环境的配置文件

 

 

通过enable()来开启/关闭：