Spring boot 和 springfox-swagger2 - $ref 值必须是符合 RFC3986 的百分比编码 URI - 提供的解决方案答案

【问题标题】：Spring boot and springfox-swagger2 - $ref values must be RFC3986-compliant percent-encoded URIs - Solution providedSpring boot 和 springfox-swagger2 - $ref 值必须是符合 RFC3986 的百分比编码 URI - 提供的解决方案
【发布时间】：2021-05-10 01:18:22
【问题描述】：

如果您使用的是 springfox-swagger2 库，则在涉及泛型类型时可能会遇到问题。在使用菱形括号的情况下，Swagger 将生成无效规范，从而导致 Swagger 编辑器中出现验证错误（“”$ref 值必须是符合 RFC3986 的百分比编码 URI”）。

您得到的错误可能如下所示：

paths./v1/car.post.parameters.0.schema.$ref 的语义错误 $ref 值必须是符合 RFC3986 的百分比编码 URI 跳转到第 45 行

【问题讨论】：

问一个问题然后自己回答是完全可以的。从您发布的内容中不清楚原始配置是什么以及解决方案是 Docket 的哪一部分。
我赞成您的问题，但我的意思是您将问题保留为问题，然后将解决方案添加为下面的答案，否则搜索时看起来没有答案。

标签： java spring-boot swagger-ui swagger-2.0

【解决方案1】：

我在Springfox documentation下发现的问题的解决方法

默认情况下，具有泛型的类型将用 '\u00ab'(>) 和逗号标记。这对于像 swagger-codegen 之类的东西可能会有问题。您可以通过实现自己的 GenericTypeNamingStrategy 来覆盖此行为。例如，如果您希望 List 编码为 'ListOfString' 而 Map 编码为 'MapOfStringAndObject' 您可以在插件自定义期间将 forCodeGeneration 自定义选项设置为 true： docket.forCodeGeneration(true|false);

这是一个添加更改的示例 Docket 配置：

@Configuration    
@EnableSwagger2
public class CommonConfiguration {

   @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .enableUrlTemplating(false)
                .forCodeGeneration(true);
    }
}

【讨论】：

当我们需要 OAS3 规范中的文档时，这不是一个有效的答案，因为它将文档转换为 OAS 2 规范。