由于Spring Boot能夠快速開發(fā)、便捷部署等特性，相信有很大一部分Spring Boot的用戶會用來構(gòu)建RESTful API。而我們構(gòu)建RESTful API的目的通常都是由于多終端的原因，這些終端會共用很多底層業(yè)務(wù)邏輯，因此我們會抽象出這樣一層來同時(shí)服務(wù)于多個(gè)移動端或者Web前端。

這樣一來，我們的RESTful API就有可能要面對多個(gè)開發(fā)人員或多個(gè)開發(fā)團(tuán)隊(duì)：IOS開發(fā)、Android開發(fā)或是Web開發(fā)等。為了減少與其他團(tuán)隊(duì)平時(shí)開發(fā)期間的頻繁溝通成本，傳統(tǒng)做法我們會創(chuàng)建一份RESTful API文檔來記錄所有接口細(xì)節(jié)，然而這樣的做法有以下幾個(gè)問題：

• 由于接口眾多，并且細(xì)節(jié)復(fù)雜（需要考慮不同的HTTP請求類型、HTTP頭部信息、HTTP請求內(nèi)容等），高質(zhì)量地創(chuàng)建這份文檔本身就是件非常吃力的事，下游的抱怨聲不絕于耳。
• 隨著時(shí)間推移，不斷修改接口實(shí)現(xiàn)的時(shí)候都必須同步修改接口文檔，而文檔與代碼又處于兩個(gè)不同的媒介，除非有嚴(yán)格的管理機(jī)制，不然很容易導(dǎo)致不一致現(xiàn)象。

為了解決上面這樣的問題，本文將介紹RESTful API的重磅好伙伴Swagger2，它可以輕松的整合到Spring Boot中，并與Spring MVC程序配合組織出強(qiáng)大RESTful API文檔。它既可以減少我們創(chuàng)建文檔的工作量，同時(shí)說明內(nèi)容又整合入實(shí)現(xiàn)代碼中，讓維護(hù)文檔和修改代碼整合為一體，可以讓我們在修改代碼邏輯的同時(shí)方便的修改文檔說明。另外Swagger2也提供了強(qiáng)大的頁面測試功能來調(diào)試每個(gè)RESTful API。具體效果如下圖所示：

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

下面的內(nèi)容我們會以教程樣例open in new window中的Chapter3-1-1進(jìn)行下面的實(shí)驗(yàn)（Chpater3-1-5是我們的結(jié)果工程，亦可參考）。

#添加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>

#創(chuàng)建Swagger2配置類

在Application.java同級創(chuàng)建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構(gòu)建RESTful APIs")
                .description("更多Spring Boot相關(guān)文章請關(guān)注：https://blog.didispace.com/")
                .termsOfServiceUrl("https://blog.didispace.com/")
                .contact("程序猿DD")
                .version("1.0")
                .build();
    }

}

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

再通過createRestApi函數(shù)創(chuàng)建Docket的Bean之后，apiInfo()用來創(chuàng)建該Api的基本信息（這些基本信息會展現(xiàn)在文檔頁面中）。select()函數(shù)返回一個(gè)ApiSelectorBuilder實(shí)例用來控制哪些接口暴露給Swagger來展現(xiàn)，本例采用指定掃描的包路徑來定義，Swagger會掃描該包下所有Controller定義的API，并產(chǎn)生文檔內(nèi)容（除了被@ApiIgnore指定的請求）。

#添加文檔內(nèi)容

在完成了上述配置后，其實(shí)已經(jīng)可以生產(chǎn)文檔內(nèi)容，但是這樣的文檔主要針對請求本身，而描述主要來源于函數(shù)等命名產(chǎn)生，對用戶并不友好，我們通常需要自己增加一些說明來豐富文檔內(nèi)容。如下所示，我們通過@ApiOperation注解來給API增加說明、通過@ApiImplicitParams、@ApiImplicitParam注解來給參數(shù)增加說明。

@RestController
@RequestMapping(value="/users")     // 通過這里配置使下面的映射都在/users下，可去除
public class UserController {

    static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());

    @ApiOperation(value="獲取用戶列表", notes="")
    @RequestMapping(value={""}, method=RequestMethod.GET)
    public List<User> getUserList() {
        List<User> r = new ArrayList<User>(users.values());
        return r;
    }

    @ApiOperation(value="創(chuàng)建用戶", notes="根據(jù)User對象創(chuàng)建用戶")
    @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體user", required = true, dataType = "User")
    @RequestMapping(value="", method=RequestMethod.POST)
    public String postUser(@RequestBody User user) {
        users.put(user.getId(), user);
        return "success";
    }

    @ApiOperation(value="獲取用戶詳細(xì)信息", notes="根據(jù)url的id來獲取用戶詳細(xì)信息")
    @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return users.get(id);
    }

    @ApiOperation(value="更新用戶詳細(xì)信息", notes="根據(jù)url的id來指定更新對象，并根據(jù)傳過來的user信息來更新用戶詳細(xì)信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體user", required = true, dataType = "User")
    })
    @RequestMapping(value="/{id}", method=RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody User user) {
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }

    @ApiOperation(value="刪除用戶", notes="根據(jù)url的id來指定刪除對象")
    @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id) {
        users.remove(id);
        return "success";
    }

}

完成上述代碼添加上，啟動Spring Boot程序，訪問：http://localhost:8080/swagger-ui.html 。就能看到前文所展示的RESTful API的頁面。我們可以再點(diǎn)開具體的API請求，以POST類型的/users請求為例，可找到上述代碼中我們配置的Notes信息以及參數(shù)user的描述信息，如下圖所示。

#API文檔訪問與調(diào)試

在上圖請求的頁面中，我們看到user的Value是個(gè)輸入框？是的，Swagger除了查看接口功能外，還提供了調(diào)試測試功能，我們可以點(diǎn)擊上圖中右側(cè)的Model Schema（黃色區(qū)域：它指明了User的數(shù)據(jù)結(jié)構(gòu)），此時(shí)Value中就有了user對象的模板，我們只需要稍適修改，點(diǎn)擊下方“Try it out！”按鈕，即可完成了一次請求調(diào)用！

此時(shí)，你也可以通過幾個(gè)GET請求來驗(yàn)證之前的POST請求是否正確。

相比為這些接口編寫文檔的工作，我們增加的配置內(nèi)容是非常少而且精簡的，對于原有代碼的侵入也在忍受范圍之內(nèi)。因此，在構(gòu)建RESTful API的同時(shí)，加入swagger來對API文檔進(jìn)行管理，是個(gè)不錯的選擇。