Swagger3.0与Swagger2对比

本文介绍了如何在Spring Boot项目中使用Springfox 3.0.0来集成OpenAPI3,简化了依赖管理,并提供了详细的配置步骤。包括添加Maven坐标、启用@EnableOpenApi注解、修改Docket构造函数参数以及配置扫描路径。同时,文章展示了如何通过配置文件控制Swagger的开关,并给出了示例配置。
摘要由CSDN通过智能技术生成

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

参考:Springfox 3.0.0(包含springfox-swagger2-3.0.0)即OpenAPI 3的发布与系统集成

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

使用流程
1.导入Maven坐标
优化:openapi3依赖添加,现在非常方便,不像以往2.9.2版本需要好几个依赖,现在只需添加一个

io.springfox springfox-boot-starter 3.0.0

2.配置
推荐配置文件和代码分离
注解的更改:由之前的@Swagger2更改为@EnableOpenApi
Docket构造函数中的DocumentationType指向更改:由之前的DocumentationType.SWAGGER_2 更改为DocumentationType.OAS_30
对于扫描路径部分可以自行选择(当项目人多的时候可以自由扩展,人少就自行安排)
paths(PathSelectors.regex(“asds”)
.or(PathSelectors.regex(“adsd”))
.or(…)
)

此外还具备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

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值