一、為什么要用 Swagger

現在的開發模式，一般都是前后端分離的，開發接口文檔就顯得尤為重要，前端人員需要按照后端的功能文檔調用對應的接口。在沒有使用 API 文檔之前，很多公司都是在紙或者 MarkDown 上寫文檔，不僅效率低，在進行前后端交互的時候也很容易出問題。

Swagger 是一款 API 構建工具，用于滿足開發人員構建 API 的需求。Swagger 使用交互式的 API 文檔來改善開發人員的體驗，并提供無開銷的測試功能，還支持可視化的 UI 文檔界面。通過 UI 文檔界面，前端人員可以很清楚的知道每個接口對應的功能，后端開發人員也可以進行相應的代碼測試。

二、Spring Boot 整合 Swagger

在 SpringBoot 中整合 Swagger 很簡單，只需要添加對應的依賴、然后配置相關的 Bean 即可，然后使用合適的注解用于文檔說明，下面我們就來這么做。

在 pom.xml 中引入對應的依賴

<!-- 引入 swagger 對應的依賴 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.7.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.7.0</version></dependency>

Swagger 配置類 SwaggerConfiguration

@Configuration @EnableSwagger2 public class SwaggerConfiguration {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.jas")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("swagger構建api文檔").description("swaggerTest").version("1.0").build();} }

測試的 Controller

@ResponseBody@GetMapping("/test")@ApiOperation(value = "swagger 測試", httpMethod = "GET", response = String.class)public String testSwagger(String userName) {return "Hello " + userName;}

三、訪問 UI 頁面文檔

輸入 http://{ip地址}:{端口號}/{資源路徑，如果有配置}/swagger-ui.html 即可訪問到 Swagger 文檔頁面，如下

后端開發人員可以在 API 文檔上進行測試，方便問題的排查，前端人員也可以很清晰的知道每個接口對應的功能，然后就可以放心的開發啦。

四、常用的文檔注解與屬性

@ApiProperty：用對象接收參數時，說明屬性信息

@ApiParam：描述某個參數

@Api：用于標注在 Controller 上

• description：Controller 描述信息

@ApiOperation ：對 Controller 中的資源進行定義

• value：說明信息
• httpMethod：HTTP 請求的方式
• response：返回值類型

總結

以上是生活随笔為你收集整理的Spring Boot 整合 Swagger的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。