Spring Boot2 系列教程(十七)SpringBoot 整合 Swagger2

前後端分離後，維護介面文件基本上是必不可少的工作。

一個理想的狀態是設計好後，介面文件發給前端和後端，大夥按照既定的規則各自開發，開發好了對接上了就可以上線了。當然這是一種非常理想的狀態，實際開發中卻很少遇到這樣的情況，介面總是在不斷的變化之中，有變化就要去維護，做過的小夥伴都知道這件事有多麼頭大！還好，有一些工具可以減輕我們的工作量，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，我來向小夥伴們分別說明：

1. @Api 註解可以用來標記當前 Controller 的功能。
2. @ApiOperation 註解用來標記一個方法的作用。
3. @ApiImplicitParam 註解用來描述一個引數，可以配置引數的中文含義，也可以給引數設定預設值，這樣在介面測試的時候可以避免手動輸入。
4. 如果有多個引數，則需要使用多個 @ApiImplicitParam 註解來描述，多個 @ApiImplicitParam 註解需要放在一個 @ApiImplicitParams 註解中。
5. 需要注意的是，@ApiImplicitParam 註解中雖然可以指定引數是必填的，但是卻不能代替 @RequestParam(required = true) ，前者的必填只是在 Swagger2 框架內必填，拋棄了 Swagger2 ，這個限制就沒用了，所以假如開發者需要指定一個引數必填， @RequestParam(required = true) 註解還是不能省略。
6. 如果引數是一個物件（例如上文的更新介面），對於引數的描述也可以放在實體類中。例如下面一段程式碼：

@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 乾貨！