Spring Boot 集成 Swagger2 教程

上篇講過 Spring Boot RESTful api ，這篇簡單介紹下 SwaggerUI 在 Spring Boot 中的應用.

Swagger 是一個規范和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務的接口文檔。

本文主要目的

1. 學會 Spring Boot 中集成 Swagger2
2. 了解 Swagger2 的主要注解並會使用
3. 美化 Swagger2 在 Spring Boot 的界面展示

1 創建一個 Spring Boot 項目

本項目主要使用 Spring Boot RESTful api 代碼，

為了方便，直接使用了 Spring Boot RESTful api 的示例代碼，為代碼增加 SwaggerUI 組件功能。

1. File > New > Project，如下圖選擇 Spring Initializr 然后點擊 【Next】下一步
2. 填寫 GroupId（包名）、Artifact（項目名） 即可。點擊 下一步
   groupId=com.fishpro
   artifactId=swagger2
3. 選擇依賴 Spring Web Starter 前面打鈎,在模板列中勾選 thymeleaf。
4. 項目名設置為 spring-boot-study-swagger2.

2 Pom.xml 依賴管理

swagger2 使用了 io.springfox.springfox-swagger2 包名，maven倉庫地址，截止目前最新版本為 2.9.2。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.fishpro</groupId>
    <artifactId>swagger2</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>swagger2</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <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>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

我們修改了 application.yml

server:
  port: 8086

3 編寫示例代碼

回顧下 Spring Boot RESTful api 我們新增了

• controller/UserController.java
• domain/UserDO.java
  進行測試，本章新增

3.1 配置 Swagger

注意：Swagger 的不同版本，配置其實是不同的。@EnableSwagger2 在 2.8.0 以及以上版本是找不到的，不知道網上大神是怎么引用的。所以我們引用 Swagger 2.7.0 版本

新建 Swagger2Config.java 包 com.fishpro.swagger2.Swagger2Config。

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))//這是注意的代碼
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xxx接口文檔")
                .description("xxx相關接口的文檔")
                .termsOfServiceUrl("http://www.xxx.com")
                .version("1.0")
                .build();
    }
}

在瀏覽器中輸入 http://localhost:8086/swagger-ui.html

可以看到 swagger-ui 界面，但此時沒有任何信息

3.2 注解概述

注解	注解說明	示例
@Api	用在類上標注類為 swagger 資源	@Api(value = "用戶接口")
@ApiOperation	用在方法上，說明方法的作用	@ApiOperation(value ="獲取用戶全部信息",tags = "查詢用戶",notes = "注意這里沒有分頁")
@ApiParam	用在請求參數前，請求屬性	同上第二條
@ApiImplicitParam	用在方法上，在方法上獨立表示參數	@ApiImplicitParam(name = "userId", value = "用戶標識", required = true, paramType = "query", dataType = "String")
@ApiImplicitParams	用在方法上，多個參數	多個 @ApiImplicitParam 集合
@ApiResponse	用方法上，響應配置	@ApiResponse(code = 200, message = "成功返回用戶信息") 對返回狀態備注
@ApiResponses	用方法上，響應集配置	用於多個 ApiResponse 配置
@ResponseHeader	用方法上，響應頭設置	相應投配置
@ApiModel	用在實體對象的類上	在 UserDO 上加入 @ApiModel(value="user對象",description="用戶對象user")
@ApiModelProperty	用在實體對象屬性上	在 @ApiModelProperty(value="用戶名",name="username",example="fishpro")
@ApiIgnore	用在類上或方法上

3.2 示例代碼

本示例是對一個用戶對象進行增刪改查的操作，也是HTTP的 GET\POST\PUT\DELETE 操作。
如下描述，運行起來比較

3.2.1 實體類代碼 domain/UserDO.java

@ApiModel(value="user對象",description="用戶對象user")
public class UserDO {
    @ApiModelProperty(value="用戶ID",name="userId",example="1")
    private Integer userId;
    @ApiModelProperty(value="用戶名",name="userName",example="fishpro")
    private String userName;

    public Integer getUserId() {
        return userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }
}

3.3.2 控制層代碼 UserController.java

/**
 * RESTful API 風格示例 對資源 user 進行操作
 * 本示例沒有使用數據庫，也沒有使用 service 類來輔助完成，所有操作在本類中完成
 * */
@RestController
@RequestMapping("/api/user")
@Api(value = "用戶接口")
public class UserController {
    /**
     * 模擬一組數據
     * */
    private List<UserDO> getData(){
        List<UserDO> list=new ArrayList<>();

        UserDO userDO=new UserDO();
        userDO.setUserId(1);
        userDO.setUserName("admin");
        list.add(userDO);

        userDO=new UserDO();
        userDO.setUserId(2);
        userDO.setUserName("heike");
        list.add(userDO);

        userDO=new UserDO();
        userDO.setUserId(3);
        userDO.setUserName("tom");
        list.add(userDO);

        userDO=new UserDO();
        userDO.setUserId(4);
        userDO.setUserName("mac");
        list.add(userDO);

        return  list;
    }


    /**
     * SELECT 查詢操作，返回一個JSON數組
     * 具有冪等性
     * */
    @GetMapping("/users")
    @ResponseStatus(HttpStatus.OK)
    @ApiOperation(value ="獲取用戶全部信息",tags = "查詢用戶",notes = "注意這里沒有分頁")
    public Object getUsers(){
        List<UserDO> list=new ArrayList<>();

        list=getData();

        return list;
    }

    /**
     * SELECT 查詢操作，返回一個新建的JSON對象
     * 具有冪等性
     * */
    @GetMapping("/users/{id}")
    @ResponseStatus(HttpStatus.OK)
    @ApiOperation(value ="獲取指定ID用戶信息",tags = "查詢用戶",notes = "注意這里的參數id")
    public Object getUser(@PathVariable("id") @ApiParam(name="id",value="用戶ID") String id){

        if(null==id){
            return  null;
        }

        List<UserDO> list= getData();
        UserDO userDO=null;
        for (UserDO user:list
             ) {
            if(id.equals(user.getUserId().toString())){
                userDO=user;
                break;
            }
        }

        return userDO;
    }

    /**
     * 新增一個用戶對象
     * 非冪等
     * */
    @PostMapping("/users")
    @ResponseStatus(HttpStatus.CREATED)
    @ApiOperation(value ="新增一個用戶",tags = "操作用戶",notes = "客戶端提供用戶實體Json")
    @ApiImplicitParams({
            @ApiImplicitParam(name="user",value = "用戶實體",required = true,dataType = "UserDO")
    })
    public Object addUser(@RequestBody UserDO user){

        List<UserDO> list= getData();
        list.add(user);//模擬向列表中增加數據
        return user;
    }

    /**
     * 編輯一個用戶對象
     * 冪等性
     * */
    @PutMapping("/users/{id}")
    @ResponseStatus(HttpStatus.CREATED)
    @ApiOperation(value ="更新一個用戶",tags = "操作用戶",notes = "客戶端提供用戶實體Json")
    public Object editUser(@PathVariable("id") @ApiParam(name="id",value="用戶ID") String id,@RequestBody UserDO user){
        List<UserDO> list= getData();
        for (UserDO userDO1:list
                ) {
            if(id.equals(userDO1.getUserId().toString())){
                userDO1=user;
                break;
            }
        }

        return user;
    }

    /**
     * 刪除一個用戶對象
     * 冪等性
     * */
    @DeleteMapping("/users")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    @ApiOperation(value ="刪除用戶",tags = "操作用戶",notes = "客戶端提供用戶實體Json")
    public Object deleteUser(@PathVariable("id") @ApiParam(name="id",value="用戶ID") String id){
        List<UserDO> list= getData();
        UserDO userDO=null;
        for (UserDO user:list
                ) {
            if(id.equals(user.getUserId().toString())){
                //刪除用戶
                userDO=user;
                break;
            }
        }
        return  userDO;//返回被刪除的對象
    }
}

3.2.3 測試最終效果

4 使用 swagger-bootstrap-ui 美化 SwaggerUI 界面

如上圖，我認為 SwaggerUI 還是不錯的，不算很丑，只是不符合當下互聯網簡約的審美觀點。

在 pom 中加入

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.3</version>
        </dependency>

在瀏覽器中訪問 http://localhost:8086/doc.html