看了翟永超的文章，把自己的心得記錄一下。在使用springboot開發API介面的時候，如果沒有完整的制度來管理，經常會出現介面和文件不同步。每次更新介面後更新文件也挺鬧心。

swagger2可以解決這個問題，在springboot中引入swagger後，新增必要的說明，可以自動生成網頁版的介面說明，還提供示例測試介面。

1.新增依賴

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

2.建立swagger配置類

@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("填寫介面的描述資訊")
                .termsOfServiceUrl("url地址")
                .contact("聯絡人")
                .version("1.0")
                .build();
    }

}
 

如上程式碼所示，通過@Configuration註解，讓Spring來載入該類配置。再通過@EnableSwagger2註解來啟用Swagger2。

再通過createRestApi函式建立Docket的Bean之後，apiInfo()用來建立該Api的基本資訊（這些基本資訊會展現在文件頁面中）。select()函式返回一個ApiSelectorBuilder例項用來控制哪些介面暴露給Swagger來展現，本例採用指定掃描的包路徑來定義，Swagger會掃描該包下所有Controller定義的API，併產生文件內容（除了被@ApiIgnore指定的請求）。

3.新增文件內容

在完成了上述配置後，其實已經可以生產文件內容，但是這樣的文件主要針對請求本身，而描述主要來源於函式等命名產生，對使用者並不友好，我們通常需要自己增加一些說明來豐富文件內容。如下所示，我們通過@ApiOperation

@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="建立使用者", notes="根據User物件建立使用者")
    @ApiImplicitParam(name = "user", value = "使用者詳細實體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="獲取使用者詳細資訊", notes="根據url的id來獲取使用者詳細資訊")
    @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="更新使用者詳細資訊", notes="根據url的id來指定更新物件，並根據傳過來的user資訊來更新使用者詳細資訊")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "使用者ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "使用者詳細實體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="根據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的頁面。我們可以再點開具體的API請求，以POST型別的/users請求為例，可找到上述程式碼中我們配置的Notes資訊以及引數user的描述資訊，如下圖所示。

4.API文件訪問與除錯

在上圖請求的頁面中，我們看到user的Value是個輸入框？是的，Swagger除了檢視介面功能外，還提供了除錯測試功能，我們可以點選上圖中右側的Model Schema（黃色區域：它指明瞭User的資料結構），此時Value中就有了user物件的模板，我們只需要稍適修改，點選下方“Try it out！”按鈕，即可完成了一次請求呼叫！

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

相比為這些介面編寫文件的工作，我們增加的配置內容是非常少而且精簡的，對於原有程式碼的侵入也在忍受範圍之內。因此，在構建RESTful API的同時，加入swagger來對API文件進行管理，是個不錯的選擇。