Swagger3.0与Swagger2对比

前言

在写项目的时候，想到swagger3已经更新了，于是想着尝鲜使用下，的确省去了很多配置。
这里写下使用流程。

参考：Springfox 3.0.0（包含springfox-swagger2-3.0.0）即OpenAPI 3的发布与系统集成

官网地址：https://swagger.io/resources/open-api/

使用流程

1.导入Maven坐标

优化：openapi3依赖添加，现在非常方便，不像以往2.9.2版本需要好几个依赖，现在只需添加一个

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

2.配置

1. 推荐配置文件和代码分离
2. 注解的更改：由之前的@Swagger2更改为@EnableOpenApi
3. Docket构造函数中的DocumentationType指向更改：由之前的DocumentationType.SWAGGER_2 更改为DocumentationType.OAS_30
4. 对于扫描路径部分可以自行选择（当项目人多的时候可以自由扩展，人少就自行安排）

paths(PathSelectors.regex("asds")
                        .or(PathSelectors.regex("adsd"))
                        .or(...)
                )

5. 此外还具备swagger进行授权配置，在开发环境的基础上进一步封装

@PropertySource(value = {"classpath:/config/Swagger3.properties"})
@EnableOpenApi
@Configuration
public class Swagger3Config {

    @Value("${nature.restApi.enabled}")
    private Boolean enable;

    @Value("${application.name}")
    private String applicationName;

    @Value("${application.version}")
    private String applicationVersion;

    @Value("${application.description}")
    private String applicationDescription;

    @Value("${application.group01}")
    private String applicationGroup01;

    @Value("${application.apis.selector}")
    private String selector;


    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .groupName(applicationGroup01)
                .select()
                .apis(RequestHandlerSelectors.basePackage(selector))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(applicationName)
                .description(applicationDescription)
                .version(applicationVersion)
                .build();
    }

}

对应的配置文件信息

# 是否开启swagger，开发环境打开，线上关闭
nature.restApi.enabled=true
# 项目名称
application.name=SecKill-应用服务API
# 项目版本信息
application.version=1.0
# 项目描述信息
application.description=秒杀-API接口文档
# 分组信息(可自行添加)
application.group01=lyh
# 扫描路径选择
application.apis.selector=com.gan.springseckill.controller

3.项目演示

只是做了常用配置，具体的可以参考：Swagger常用配置