使用Swagger2構建強大的RESTful API文檔（1）（二十二）

因爲Spring Boot可以快速開發、便捷部署等特性，相信有很大一部分Spring Boot的用戶會用來構建RESTful API。而咱們構建RESTful API的目的一般都是因爲多終端的緣由，這些終端會共用不少底層業務邏輯，所以咱們會抽象出這樣一層來同時服務於多個移動端或者Web前端。

這樣一來，咱們的RESTful API就有可能要面對多個開發人員或多個開發團隊：IOS開發、Android開發或是Web開發等。爲了減小與其餘團隊平時開發期間的頻繁溝通成本，傳統作法咱們會建立一份RESTful API文檔來記錄全部接口細節，然而這樣的作法有如下幾個問題：

• 因爲接口衆多，而且細節複雜（須要考慮不一樣的HTTP請求類型、HTTP頭部信息、HTTP請求內容等），高質量地建立這份文檔自己就是件很是吃力的事，下游的抱怨聲不絕於耳。
• 隨着時間推移，不斷修改接口實現的時候都必須同步修改接口文檔，而文檔與代碼又處於兩個不一樣的媒介，除非有嚴格的管理機制，否則很容易致使不一致現象。

爲了解決上面這樣的問題，本文將介紹RESTful API的重磅好夥伴Swagger2，它能夠輕鬆的整合到Spring Boot中，並與Spring MVC程序配合組織出強大RESTful API文檔。它既能夠減小咱們建立文檔的工做量，同時說明內容又整合入實現代碼中，讓維護文檔和修改代碼整合爲一體，可讓咱們在修改代碼邏輯的同時方便的修改文檔說明。另外Swagger2也提供了強大的頁面測試功能來調試每一個RESTful API。具體效果以下圖所示：

alt=

下面來具體介紹，若是在Spring Boot中使用Swagger2。首先，咱們須要一個Spring Boot實現的RESTful API工程，若您沒有作過這類內容，建議先閱讀
Spring Boot構建一個較爲複雜的RESTful APIs和單元測試。

下面的內容咱們會以教程樣例中的Chapter3-1-1進行下面的實驗（Chpater3-1-5是咱們的結果工程，亦可參考）。

添加Swagger2依賴

在pom.xml中加入Swagger2的依賴

1 2 3 4 5 6 7 8 9 10

<dependency>      <groupId>io.springfox</groupId>      <artifactId>springfox-swagger2</artifactId>      <version> 2.2 . 2 </version> </dependency> <dependency>      <groupId>io.springfox</groupId>      <artifactId>springfox-swagger-ui</artifactId>      <version> 2.2 . 2 </version> </dependency>

　　

建立Swagger2配置類

在Application.java同級建立Swagger2的配置類Swagger2。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

@Configuration @EnableSwagger2 public  class  Swagger2 {        @Bean      public  Docket createRestApi() {          return  new  Docket(DocumentationType.SWAGGER_2)                  .apiInfo(apiInfo())                  .select()                  .apis(RequestHandlerSelectors.basePackage( "com.didispace.web" ))                  .paths(PathSelectors.any())                  .build();      }        private  ApiInfo apiInfo() {          return  new  ApiInfoBuilder()                  .title( "Spring Boot中使用Swagger2構建RESTful APIs" )                  .description( "更多Spring Boot相關文章請關注：http://blog.didispace.com/" )                  .termsOfServiceUrl( "http://blog.didispace.com/" )                  .contact( "程序猿DD" )                  .version( "1.0" )                  .build();      }   }

　　

如上代碼所示，經過@Configuration註解，讓Spring來加載該類配置。再經過@EnableSwagger2註解來啓用Swagger2。

再經過createRestApi函數建立Docket的Bean以後，apiInfo()用來建立該Api的基本信息（這些基本信息會展示在文檔頁面中）。select()函數返回一個ApiSelectorBuilder實例用來控制哪些接口暴露給Swagger來展示，本例採用指定掃描的包路徑來定義，Swagger會掃描該包下全部Controller定義的API，併產生文檔內容（除了被@ApiIgnore指定的請求）。