Spring Boot 集成 Swagger，生成接口文檔就這麼簡單！

時間 2019-12-11

標籤 spring boot 集成 swagger 生成接口文檔簡單欄目 Spring 简体版

原文原文鏈接

以前的文章介紹了《推薦一款接口 API 設計神器！》，今天棧長給你們介紹下如何與優秀的 Spring Boot 框架進行集成，簡直不能太簡單。html

你所需具有的基礎

更多請在Java技術棧微信公衆號後臺回覆關鍵字：boot。java

Spring Boot 集成 Swagger

一、添加依賴

Maven依賴示例：web

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
</dependency>

二、在 Spring Boot 配置文件中添加配置參數。

swagger:
  title: API標題
  description: API描述
  version: 1.0
  terms-of-service-url: http://www.javastack.cn/
  base-package: cn.javastack.test.web
  contact:
    name: Javastack
    url: http://www.javastack.cn/
    email: admin@javastack.cn

三、添加配置類

@Getter
@Setter
@Configuration
@EnableSwagger2
@ConditionalOnClass(EnableSwagger2.class)
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfig {

    /**
     * API接口包路徑
     */
    private String basePackage;

    /**
     * API頁面標題
     */
    private String title;

    /**
     * API描述
     */
    private String description;

    /**
     * 服務條款地址
     */
    private String termsOfServiceUrl;

    /**
     * 版本號
     */
    private String version;

    /**
     * 聯繫人
     */
    private Contact contact;
    
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)
                .version(version)
                .contact(contact)
                .build();
    }

}

如何使用

Swagger 默認會根據配置的包，掃描全部接口並生成對應的 API 描述和參數信息，但這樣不是很直觀，須要對每一個接口和參數進行自定義描述。spring

經常使用的 Swagger 註解以下。api

註解名稱	使用說明
@Api	描述一個 API 類
@ApiImplicitParam	描述一個請求參數
@ApiImplicitParams	描述一組請求參數
@ApiModel	描述一個返回的對象
@ApiModelProperty	描述一個返回的對象參數
@ApiOperation	描述一個 API 方法
@ApiParam	描述一個方法的參數
@ApiResponse	描述一個請求響應
@ApiResponses	描述一組請求響應

使用示例如：微信

@Api(description = "登陸模塊")
@RestController
public class LoginController {
    
    @ApiOperation(value = "登陸", httpMethod = "POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "用戶名", dataType = "string", paramType = "query"),
            @ApiImplicitParam(name = "password", value = "密碼", dataType = "string", paramType = "query")})
    @PostMapping(value = "/login")
    public Object login(@RequestParam("username") String username, @RequestParam("password") String password) {
    
        // ...
          
    }
}