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工程，若您沒有作過這類內容，建議先閱讀
Spring Boot構建一個較爲複雜的RESTful APIs和單元測試。

添加Swagger2依賴

在pom.xml中加入Swagger2的依賴

1 2 3 4 5 6 7 8 9 10 11

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

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

添加文檔內容

在完成了上述配置後，其實已經能夠生產文檔內容，可是這樣的文檔主要針對請求自己，而描述主要來源於函數等命名產生，對用戶並不友好，咱們一般須要本身增長一些說明來豐富文檔內容。以下所示，咱們經過@ApiOperation註解來給API增長說明、經過@ApiImplicitParams、@ApiImplicitParam註解來給參數增長說明。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

@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文檔進行管理，是個不錯的選擇。

參考信息

• Swagger官方網站

本文由 程序猿DD-翟永超 創做，採用 CC BY 3.0 CN協議 進行許可。 可自由轉載、引用，但需署名做者且註明文章出處。 

來源： http://blog.didispace.com/springbootswagger2/

來自爲知筆記(Wiz)