Spring Cloud Spring Boot 架構

由於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=alt=

下面來具體介紹，如果在Spring Boot中使用Swagger2。首先，我們需要一個Spring Boot實現的RESTful API工程，若您沒有做過這類內容，建議先閱讀
Spring Boot構建一個較為復雜的RESTful APIs和單元測試。

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

添加Swagger2依賴

在pom.xml中加入Swagger2的依賴

<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。

@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指定的請求）。

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