Spring Boot中怎樣使用Swagger2構建RESTful API文檔

這篇文章給大家介紹Spring Boot中怎樣使用Swagger2構建RESTful API文檔，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

由于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。具體效果如下圖所示：

下面來具體介紹，如果在Spring Boot中使用Swagger2。首先，我們需要一個Spring Boot實現的RESTful API工程。

添加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("desc")
                .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指定的請求）。

添加文檔內容

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

@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的描述信息，如下圖所示。

API文檔訪問與調試

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

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

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

關于Spring Boot中怎樣使用Swagger2構建RESTful API文檔就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。