前后端分離后，維護接口文檔基本上是必不可少的工作。
一個理想的狀態是設計好后，接口文檔發給前端和后端，大伙按照既定的規則各自開發，開發好了對接上了就可以上線了。當然這是一種非常理想的狀態，實際開發中卻很少遇到這樣的情況，接口總是在不斷的變化之中，有變化就要去維護，做過的小伙伴都知道這件事有多么頭大！還好，有一些工具可以減輕我們的工作量，Swagger2 就是其中之一，至於其他類似功能但是卻收費的軟件，這里就不做過多介紹了。本文主要和大伙來聊下 在Spring Boot 中如何整合 Swagger2。
工程創建
當然，首先是創建一個 Spring Boot 項目，加入 web 依賴，創建成功后，加入兩個 Swagger2 相關的依賴，完整的依賴如下：
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
Swagger2 配置
Swagger2 的配置也是比較容易的，在項目創建成功之后，只需要開發者自己提供一個 Docket 的 Bean 即可，如下：
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.pathMapping("/")
.select()
.apis(RequestHandlerSelectors.basePackage("org.javaboy.controller"))
.paths(PathSelectors.any())
.build().apiInfo(new ApiInfoBuilder()
.title("SpringBoot整合Swagger")
.description("SpringBoot整合Swagger，詳細信息......")
.version("9.0")
.contact(new Contact("啊啊啊啊","blog.csdn.net","aaa@gmail.com"))
.license("The Apache License")
.licenseUrl("http://www.javaboy.org")
.build());
}
}
這里提供一個配置類，首先通過 @EnableSwagger2 注解啟用 Swagger2 ，然后配置一個 Docket Bean，這個 Bean 中，配置映射路徑和要掃描的接口的位置，在 apiInfo 中，主要配置一下 Swagger2 文檔網站的信息，例如網站的 title，網站的描述，聯系人的信息，使用的協議等等。
如此，Swagger2 就算配置成功了，非常方便。
此時啟動項目，輸入 http://localhost:8080/swagger-ui.html，能夠看到如下頁面，說明已經配置成功了：
創建接口
接下來就是創建接口了，Swagger2 相關的注解其實並不多，而且很容易懂，下面我來分別向小伙伴們舉例說明：
@RestController
@Api(tags = "用戶管理相關接口")
@RequestMapping("/user")
public class UserController {
@PostMapping("/")
@ApiOperation("添加用戶的接口")
@ApiImplicitParams({
@ApiImplicitParam(name = "username", value = "用戶名", defaultValue = "李四"),
@ApiImplicitParam(name = "address", value = "用戶地址", defaultValue = "深圳", required = true)
})
public RespBean addUser(String username, @RequestParam(required = true) String address) {
return new RespBean();
}
@GetMapping("/")
@ApiOperation("根據id查詢用戶的接口")
@ApiImplicitParam(name = "id", value = "用戶id", defaultValue = "99", required = true)
public User getUserById(@PathVariable Integer id) {
User user = new User();
user.setId(id);
return user;
}
@PutMapping("/{id}")
@ApiOperation("根據id更新用戶的接口")
public User updateUserById(@RequestBody User user) {
return user;
}
}
這里邊涉及到多個 API，我來向小伙伴們分別說明：
- @Api 注解可以用來標記當前 Controller 的功能。
- @ApiOperation 注解用來標記一個方法的作用。
- @ApiImplicitParam 注解用來描述一個參數，可以配置參數的中文含義，也可以給參數設置默認值，這樣在接口測試的時候可以避免手動輸入。
- 如果有多個參數，則需要使用多個 @ApiImplicitParam 注解來描述，多個 @ApiImplicitParam 注解需要放在一個 @ApiImplicitParams 注解中。
- 需要注意的是，@ApiImplicitParam 注解中雖然可以指定參數是必填的，但是卻不能代替 @RequestParam(required = true) ，前者的必填只是在 Swagger2 框架內必填，拋棄了 Swagger2 ，這個限制就沒用了，所以假如開發者需要指定一個參數必填， @RequestParam(required = true) 注解還是不能省略。
- 如果參數是一個對象（例如上文的更新接口），對於參數的描述也可以放在實體類中。例如下面一段代碼：
@ApiModel
public class User {
@ApiModelProperty(value = "用戶id")
private Integer id;
@ApiModelProperty(value = "用戶名")
private String username;
@ApiModelProperty(value = "用戶地址")
private String address;
//getter/setter
}
好了，經過如上配置之后，接下來，刷新剛剛打開的頁面，可以看到如下效果：
可以看到，所有的接口這里都列出來了，包括接口請求方式，接口地址以及接口的名字等，點開一個接口，可以看到如下信息：
可以看到，接口的參數，參數要求，參數默認值等等統統都展示出來了，參數類型下的 query 表示參數以 key/value 的形式傳遞，點擊右上角的 Try it out，就可以進行接口測試：
點擊 Execute 按鈕，表示發送請求進行測試。測試結果會展示在下面的 Response 中。
小伙伴們注意，參數類型下面的 query 表示參數以 key/value 的形式傳遞，這里的值也可能是 body，body 表示參數以請求體的方式傳遞，例如上文的更新接口，如下：
當然還有一種可能就是這里的參數為 path，表示參數放在路徑中傳遞，例如根據 id 查詢用戶的接口：
當然，除了這些之外，還有一些響應值的注解，都比較簡單，小伙伴可以自己摸索下。
在 Security 中的配置
如果我們的 Spring Boot 項目中集成了 Spring Security，那么如果不做額外配置，Swagger2 文檔可能會被攔截，此時只需要在 Spring Security 的配置類中重寫 configure 方法，添加如下過濾即可：
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring()
.antMatchers("/swagger-ui.html")
.antMatchers("/v2/**")
.antMatchers("/swagger-resources/**");
}
如此之后，Swagger2 文件就不需要認證就能訪問了。不知道小伙伴們有沒有看懂呢？有問題歡迎留言討論。
關注公眾號【江南一點雨】，專注於 Spring Boot+微服務以及前后端分離等全棧技術，定期視頻教程分享，關注后回復 Java ，領取松哥為你精心准備的 Java 干貨！
