摘要：在項目開發中，往往期望做到前後端分離，也就是後端開發人員往往需要輸出大量的服務接口，接口的提供方無論是是Java還是PHP等語言，往往會要花費一定的精力去寫接口文檔，比如A接口的地址、需要傳遞參數情況、返回值的JSON數據格式以及每一個字段說明、當然還要考慮HTTP請求頭、請求內容等信息。隨著項目的進度快速高速的迭代，後端輸出的接口往往會面臨修改、修復等問題，那也意味著接口文檔也要進行相應的調整。接口文檔的維護度以及可讀性就大大下降。
既然接口文檔需要花費精力去維護，還要適當的進行面對面交流溝通，我們何不想一個辦法，第一：可以不用寫接口文檔；第二：前端與後端溝通接口問題的時候，後端是否可以提供一個URL，在這個URL中羅列出所有可以調用的服務接口，並在每個服務接口中羅列出參數的說明，返回值的說明，第三：後端接口如果能模擬調用就所有問題都解決了。本文我們重點講解一下Sringboot中集成Swagger2框架。
1.1. 添加Swagger2依賴
在項目的pom.xml文件中增加如下的依賴。
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version></dependency>
首先，我們需要建立一個啟動類，代碼如下：
@SpringBootApplicationpublic class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }}然後在上述類的同級目錄中新建swagger2的配置類如下所示：
@Configuration@EnableSwagger2public class Swagger2 { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.shareniu.web")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("跟著分享牛學習Springboot源碼分析系列課程") .description("更多Spring Boot相關文章請關注分享牛的博客") .termsOfServiceUrl("http://www.shareniu.com/") .contact("牛牛") .license("Copyright 2017-2018 分享牛") .version("1.0") .build(); }}@Configuration制定了spring要加載這個類，@EnableSwagger2註解要開啟Swagger功能。
上述中的ApiInfo最終都會展現在前端，我們使用了掃描包的方式配置配置，也就是RequestHandlerSelectors.basePackage。在這個包以及子包中的控制器最終都是生成API文檔。 （除了被@ApiIgnore註解指定的請求）。
1.2. 新增文檔說明
上述的類聲明之後，我們其實就可以直接調用了，但是為了增加文檔的可讀性，我們還是需要在接口中增加一些說明，我們先寫一個控制器如下所示：
@RestController@RequestMapping(value="/users")public class UserController { static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>()); static { User user = new User(); user.setAge(18); user.setId(1L); user.setName("aa"); users.put(1L, 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來指定更新對象") @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"; }} @ApiOperation：用來描述該接口的作用。可以通過該註解說明接口的職責、返回頭信息、方法的請求方式（"GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"）、協議（ http, https, ws, wss）、http狀態碼。
@ApiImplicitParam：用來給參數增加說明。可以設置參數的名稱、是否是必填項、參數的描述信息、是否只讀等。
上述代碼提交之後，啟動springboot，訪問http://127.0.0.1:8080/swagger-ui.html，如下圖所示：
上圖分為兩個部分，上部分是通過Swagger2類配置出來的，下半部分是UserController類中的接口文檔。
這裡我們以/user為例進行說明：
點擊/user如下圖所示：
上圖黃色的地方表示，該接口返回的樣例數據。也就是User的數據結構。 Response Content Type：接口返回的頭信息。點擊Try it out。如下所示：
該接口返回的baody、code碼、響應頭已經成功返回了。
總結
以上所述是小編給大家介紹的Springboot中集成Swagger2框架的方法，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對武林網網站的支持！