springboot系列十3、springboot集成swaggerUI

時間 2019-11-06

標籤 springboot 系列集成 swaggerui 欄目 Spring 简体版

原文原文鏈接

1、Swagger介紹

Swagger能成爲最受歡迎的REST APIs文檔生成工具之一，有如下幾個緣由：html

Swagger 能夠生成一個具備互動性的API控制檯，開發者能夠用來快速學習和嘗試API。
Swagger 能夠生成客戶端SDK代碼用於各類不一樣的平臺上的實現。
Swagger 文件能夠在許多不一樣的平臺上從代碼註釋中自動生成。
Swagger 有一個強大的社區，裏面有許多強悍的貢獻者。

Swagger 文檔提供了一個方法，使咱們能夠用指定的 JSON 或者 YAML 摘要來描述你的 API，包括了好比 names、order 等 API 信息。java

你能夠經過一個文本編輯器來編輯 Swagger 文件，或者你也能夠從你的代碼註釋中自動生成。各類工具均可以使用 Swagger 文件來生成互動的 API 文檔。node

2、配置及使用Swagger

一、引入依賴

<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>

二、添加配置類：SwaggerConfig.java

package com.example.demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2配置類
 * 在與spring boot集成時，放在與Application.java同級的目錄下。
 * 經過@Configuration註解，讓Spring來加載該類配置。
 * 再經過@EnableSwagger2註解來啓用Swagger2。
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 建立API應用
     * apiInfo() 增長API相關信息
     * 經過select()函數返回一個ApiSelectorBuilder實例,用來控制哪些接口暴露給Swagger來展示，
     * 本例採用指定掃描的包路徑來定義指定要創建API的目錄。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 建立該API的基本信息（這些基本信息會展示在文檔頁面中）
     * 訪問地址：http://項目實際地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2構建RESTful APIs")
                .description("更多請關注:博客園小人物的奮鬥")
                .termsOfServiceUrl("http://www.cnblogs.com/wangzhuxing")
                .contact("xing")
                .version("1.0")
                .build();
    }
}

三、使用示例

一、註解Controller類

@Controller
@RequestMapping("/User")
@Api(description = "測試swagger註解的demo")
public class HelloWorldController {

　　@ResponseBody
　　@RequestMapping(value = "/getAllUser" ,method = RequestMethod.POST)
　　@ApiOperation(value = "獲取用戶信息",notes = "返回單個用戶信息")
　　public List<UserPO> getAllUser(@ApiParam(required = false) @RequestBody User user) {
    　　userService.addUser();
    　　return userService.findAll();
　　}

二、註解入參和出參

package com.example.demo.bean;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;

public class User implements Serializable {
    @ApiModelProperty(value = "用戶id" ,example = "11")
    private Long uid;
    @ApiModelProperty(value = "用戶姓名",example = "小明")
    private String name;
    @ApiModelProperty(value = "用戶年齡",example = "25")
    private Integer age;
    public Long getUid() {
        return uid;
    }
    public void setUid(Long uid) {
        this.uid = uid;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
}

四、驗證效果

訪問：http://192.168.1.100:8080/swagger-ui.htmlweb

3、常見用法和說明

@Api：用在類上，說明該類的做用。
@ApiOperation：註解來給API增長方法說明。
@ApiImplicitParams : 用在方法上包含一組參數說明。
@ApiImplicitParam：用來註解來給方法入參增長說明。
@ApiResponses：用於表示一組響應
@ApiModel：描述一個Model的信息（通常用在請求參數沒法使用@ApiImplicitParam註解進行描述的時候）spring

l @ApiModelProperty：描述一個model的屬性express
@ApiResponse：用在@ApiResponses中，通常用於表達一個錯誤的響應信息