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