SpringBoot整合Swagger3.0

一、简介

Swagger UI 是一款 API 在线文档生成和调试工具。在需求不断变更的开发环境下，手动编写文档的效率实在太低。
在Swagger3版本中，减少了谷歌的guava依赖，更多的应用了java8的语法。新增了springboot流行的start启动包形式依赖。

二、POM添加依赖

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-boot-starter</artifactId>
   <version>3.0.0</version>
</dependency>

三、SwaggerConfig的配置

package cn.opendatachain.manage.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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * SwaggerConfig
 *
 * @author lishijian
 * @version dev-blockchain 1.0.0.RELEASE
 * <b>Creation Time:</b> 2021/3/23 10:35
 */
@Configuration
@EnableOpenApi
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        //swagger3.0使用 OAS_30
        return new Docket(DocumentationType.OAS_30)
            .apiInfo(apiInfo())
            .select()
            //此包路径下的类，才生成接口文档
            .apis(RequestHandlerSelectors.basePackage("cn.opendatachain.manage.controller"))
            //加了ApiOperation的类,才生成接口文档  
//            .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
            .paths(PathSelectors.any())
            .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("文档标题")
            .description("文档描述")
            .contact(new Contact("作者", "作者地址", "作者邮箱"))
            .version("1.0")
            .build();
    }
}

四、Swagger注解的使用说明

• @Api：用在请求的类上，表示对类的说明
  tags="说明该类的作用，可以在UI界面上看到的注解"
  value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

• @ApiOperation：用在请求的方法上，说明方法的用途、作用
  value="说明方法的用途、作用"
  notes="方法的备注说明"

• @ApiImplicitParams：用在请求的方法上，表示一组参数说明

• @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
  name：参数名
  value：参数的汉字说明、解释
  required：参数是否必须传
  paramType：参数放在哪个地方

  • header --> 请求参数的获取：@RequestHeader
  • query --> 请求参数的获取：@RequestParam
  • path（用于restful接口）--> 请求参数的获取：@PathVariable
  • body（不常用）
  • form（不常用）

  dataType：参数类型，默认String，其它值dataType="Integer"
  defaultValue：参数的默认值

• @ApiResponses：用在请求的方法上，表示一组响应

• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  code：数字，例如400
  message：信息，例如"请求参数没填好"
  response：抛出异常的类

• @ApiModel：用于响应类上，表示一个返回响应数据的信息
  （这种一般用在post创建的时候，使用@RequestBody这样的场景， 请求参数无法使用@ApiImplicitParam注解进行描述的时候）

• @ApiModelProperty：用在属性上，描述响应类的属性

五、swagger使用

• 这次更新，移除了原来默认的swagger页面路径：http://host/context-path/swagger-ui.html，新增了两个可访问路径：http://host/context-path/swagger-ui/index.html 和 http://host/context-path/swagger-ui/
• 通过调整日志级别，还可以看到新版本的swagger文档接口也有新增，除了以前老版本的文档接口/v2/api-docs之外，还多了一个新版本的/v3/api-docs接口。