第六篇：Spring Boot集成Swagger2構建RESTful API文檔

由於Spring Boot有快速開發、便捷部署等特性，所以很大一部分Spring Boot的用戶會用來構建RESTfulAPI。而我們構建RESTfulAPI的目的通常都是由於多終端的原因，這些終端會共用很多底層業務邏輯，因此我們會抽象出這樣一層來同時服務於多個移動端或者Web前端。

這樣一來，我們的RESTfulAPI就有可能要面對多個開發人員或多個開發團隊：ios開發、Android開發或是Web開發等。爲了減少與其他團隊開發期間的頻繁溝通成本，傳統做法我們會創建一份RESTfulAPI文檔來記錄所有接口細節，然而這樣的做法有以下幾個問題：

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

爲了解決上面這樣的問題，本文將介紹RESTfulAPI的重磅好夥伴Swagger2，它可以輕鬆的整合到Spring Boot中，並與Spring MVC程序配合組織出強大的RESTfulAPI文檔。它在減少我們創建文檔的工作量的同時，又將說明內容整合入代碼中，讓維護文檔和修改代碼整合爲一體，可以讓我們在修改代碼邏輯的同時方便的修改文檔說明。另外Swagger2也提供了強大的頁面測試功能來調試每個RESTfulAPI。

下面來具體介紹，如何在Spring Boot中使用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>

寫配置類

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.chenjie.springboot.learn.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot使用Swagger構建API文檔")
                .description("簡單優雅的RESTful風格，https://blog.csdn.net/Mr_Chenjie_C")
                .termsOfServiceUrl("https://blog.csdn.net/Mr_Chenjie_C")
                .version("1.0")
                .build();
    }
}

如上代碼所示

• @Configuration註解，表明它是一個配置類，讓Spring來加載該類；
• @EnableSwagger2註解來啓用Swagger；
• 通過createRestApi()創建Docket的Bean之後，apiInfo()用來創建該API的基本信息（這些基本信息會展現在文檔頁面中）；
• 再通過select()返回一個ApiSelectorBuilder實例用來控制哪些接口暴露給Swagger來展現；

本例採用指定掃描的包路徑來定義，Swagger會掃描該包下所有Controller定義的API，併產生文檔內容（除了被@ApiIgnore指定的請求）。

相關注解

swagger通過註解表明該接口會生成文檔，包括接口名、請求方法、參數、返回信息的等等。

• @Api：修飾整個類，描述Controller的作用
• @ApiOperation：描述一個類的一個方法，或者說一個接口
• @ApiParam：單個參數描述
• @ApiModel：用對象來接收參數
• @ApiProperty：用對象接收參數時，描述對象的一個字段
• @ApiResponse：HTTP響應其中1個描述
• @ApiResponses：HTTP響應整體描述
• @ApiIgnore：使用該註解忽略這個API
• @ApiError ：發生錯誤返回的信息
• @ApiParamImplicitL：一個請求參數
• @ApiParamsImplicit 多個請求參數

添加文檔內容

@RestController
@RequestMapping(value="/users")
public class UserController {

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

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

    @ApiOperation(value="創建用戶", notes="根據User對象創建用戶")
    @ApiImplicitParam(name = "user", value = "用戶實體user", required = true, dataType = "User")
    @PostMapping(value="/add")
    public String postUser(@RequestBody User user) {
        try {
            users.put(user.getId(), user);
        } catch (Exception e) {
            e.printStackTrace();
            return "fail";
        }
        return "success";
    }

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

    @ApiOperation(value="更新用戶", notes="根據url中的id來指定更新對象，並根據傳過來的user來更新用戶信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用戶實體user", required = true, dataType = "User")
    })
    @PutMapping(value="/{id}")
    public String put(@PathVariable Long id, @RequestBody User user) {
        try {
            User u = users.get(id);
            u.setName(user.getName());
            u.setAge(user.getAge());
            users.put(id, u);
        } catch (Exception e) {
            e.printStackTrace();
            return "fail";
        }
        return "success";
    }

    @ApiOperation(value="刪除用戶", notes="根據url中的id來指定刪除對象")
    @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")
    @DeleteMapping(value="/{id}")
    public String delete(@PathVariable Long id) {
        try {
            users.remove(id);
        } catch (Exception e) {
            e.printStackTrace();
            return "fail";
        }
        return "success";
    }

    @ApiIgnore//使用該註解忽略這個API
    @GetMapping(value = "/hello")
    public String ignore() {
        return "hello";
    }
}

API文檔訪問

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

API文檔訪問調試

在上圖請求的頁面中，我們看到user的Value是個輸入框，Swagger除了查看接口功能外，還提供了調試測試功能。我們可以點擊上圖中右側的Model Schema（黃色區域：它指明瞭User的數據結構），此時Value中就有了user對象的模板，我們只需要稍作修改，點擊下方“Try it out！”按鈕，即完成了一次請求調用！

此時，你也可以通過幾個GET請求來驗證之前的POST請求是否正確。

總結

跟編寫接口文檔的工作相比，我們增加的配置內容是非常少而且精簡的，對於原有代碼的侵入也在忍受範圍之內。因此，在構建RESTfulAPI的同時，加入swagger來對API文檔進行管理，是個不錯的選擇。

源碼下載：https://github.com/chenjary/SpringBoot