Swagger2升级OpenApi

2021-12-17

|已阅： 1

0. 前言

Swagger在2015年捐赠给Linux基金会后改名为OpenApi

3.0.0是OpenApi发布的第一个版本，从Swagger2升级到OpenApi改动量不大，简单记录一下升级过程

项目采用SpringCloud Hoxton.SR9 版本开发，集成了Swagger2

1. 替换依赖

删除原项目中swagger2相关依赖

<!--Swagger-UI API文档生产工具-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger2.version}</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger2.version}</version>
</dependency>
<!--解决Swagger 2.9.2版本NumberFormatException-->
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
    <version>${swagger-models.version}</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>${swagger-annotations.version}</version>
</dependency>

添加官方starter依赖

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

2. 修改Swagger配置

首先，启动注解要修改原 @EnableSwagger2 修改为 @EnableOpenApi

创建Docket时传参修改，由：

1	Docket docket = new Docket(DocumentationType.SWAGGER_2);

修改为：

1	Docket docket = new Docket(DocumentationType.OAS_30);

如果开启了Swagger Security认证则需要修改参数：

1
2
3

if (swaggerProperties.isEnableSecurity()) {
       docket.securitySchemes(securitySchemes()).securityContexts(securityContexts());
   }

securitySchemes() 方法原来的返回值为List<ApiKey>升级后需要修改返回值为List<SecurityScheme>

ApiKey类继承自SecurityScheme，所以简单修改返回类型即可，原方法：

private List<ApiKey> securitySchemes() {
      //设置请求头信息
      List<ApiKey> result = new ArrayList<>();
      ApiKey apiKey = new ApiKey("Authorization", "Authorization", "header");
      result.add(apiKey);
      return result;
  }

修改后：

private List<SecurityScheme> securitySchemes() {
      //设置请求头信息
      List<SecurityScheme> result = new ArrayList<>();
      ApiKey apiKey = new ApiKey("Authorization", "Authorization", "header");
      result.add(apiKey);
      return result;
  }

3. 启动与访问

通过以上修改后就可以正常启动程序访问了

待程序启动完成后访问地址有所修改，原地址：

1	http://localhost:8006/swagger-ui.html#/

修改后：

1	http://localhost:8006/swagger-ui/

本文作者： ixx
本文链接： http://blog.jisuye.com/2021/12/17/swagger2openapi/
版权声明： 本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。转载请注明出处！