SpringBoot - Swagger (API文檔實時更新工具)

總結

• 創建SpringBoot項目,導入Swagger依賴
  • Swagger2
  • Swagger-ui
• 創建Swagger配置類
  • 添加@Configuration注解,標識配置類
  • 添加@EnableSwagger2注解開啟Swagger
• 配置Swagger的Docket的Bean實例
• 配置Swagger信息

 

 

1. 背景

1.1 前后端分離式時代

 

前端項目會持有很多“假”數據，這些“假”數據應該通過后端從數據庫查詢而來。

然而在前后端分離時代，前端只需要知道數據的格式即可，后端只需要按需提供接口（接口產生出對應格式的數據即可）。

 

 

1.2 產生的問題

 

1.3 解決方案

早些年：用word

如今：用Swagger， Api文檔與API定義同步更新

 

2. Swagger背景

 

 

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界面位置在：

 

 

4. Swagger UI自定義配置

4.1 自定義左上角“Swagger信息”模塊

 

 

 

4.2 自定義右上角“分組”模塊

 

向ioc容器中，注冊多個Docket bean即可：

 

 

4.3 底部“實體類信息”模塊

4.3.1 如何在該模塊顯示一個實體類Model?

 

 

4.3.2 如何給實體類加注釋？

 

 

 

4.3.3 如何給Controller加注釋？

 

 

 

 

 

 

 

5. Swagger配置掃描接口

 

 

6. 模擬前端測試接口（重要）

 

 

 

 

 

 

 

 

 

面試題：如何讓開發環境使用swagger，而生產環境禁用?

前提：項目中需要有多環境的配置文件

 

 

通過enable()來開啟/關閉：