Swagger2.7升级到3.0后的若干问题

第一个问题ApiKey无法转换为SecurityScheme

对应报错

java: 不兼容的类型: java.util.List<springfox.documentation.service.ApiKey>无法转换为java.util.List<springfox.documentation.service.SecurityScheme>

• 1

对应代码

//设置的认证头
docket.securitySchemes(securitySchemes()).securityContexts(securityContexts());
//调用的方法
    private List<ApiKey> securitySchemes() {
        //3.0改变了返回结果
        List<ApiKey> result = new ArrayList<>();
        ApiKey apiKey = new ApiKey("ApiKeyAuth", "Authorization", "header");
        result.add(apiKey);
        return result;
    }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

这个报错很明显，说ApiKey无法转换为SecurityScheme，然后我看了下3.0和2.7的源码，3.0版本的方法目前只支持SecurityScheme，2.7版本的方法支持SecurityScheme的子类

解决办法
修改自定义方法的返回类型securitySchemes（）

    private List<SecurityScheme> securitySchemes() {
        //3.0改变了返回结果
        List<SecurityScheme> result = new ArrayList<>();
        ApiKey apiKey = new ApiKey("ApiKeyAuth", "Authorization", "header");
        result.add(apiKey);
        return result;
    }

• 1
• 2
• 3
• 4
• 5
• 6
• 7

第二个问题访问http://localhost:8081/swagger-ui.html报404

解决办法
对于3.0的swagger-ui，使用以下maven坐标替换springfox-swagger-ui包

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

• 1
• 2
• 3
• 4
• 5
• 6

访问路径为http://localhost:8081/swagger-ui/

第三个问题访问swagger页面报错Unable to render this definition

翻译过来就是版本不匹配，需要在代码中设置为3.0版本

解决办法
可以看下代码中创建的版本是否正确， swagger源码的版本目前有三个值，对于3.0版本要选择OAS_30

注意

对于配置了Security的项目，需要注意swagger-ui对应url资源放行

      - /swagger-ui/
      - /swagger-resources/**
      - /swagger/**
      - /**/v3/api-docs/**
      - /**/*.js
      - /**/*.css
      - /**/*.png

• 1
• 2
• 3
• 4
• 5
• 6
• 7