解决swagger返回map复杂结构不能解析 Resolver error at definitions

最新推荐文章于 2023-12-08 15:20:52 发布

原创最新推荐文章于 2023-12-08 15:20:52 发布 · 6.9k 阅读

4 ·

CC 4.0 BY-SA版权

java 专栏收录该内容

86 篇文章

订阅专栏

本文详细介绍了如何使用Swagger配置API文档，特别是针对返回类型为Map<String,List<VersionPushStatisticResp>>时的配置方法，通过使用alternateTypeRules解决Swagger页面的报错问题。

解决：

@Configuration
public class SwaggerConfig {

    @Autowired
    private TypeResolver typeResolver;

    @Bean
    public Docket controllerApi() {
//        ParameterBuilder ticketPar = new ParameterBuilder();
//        List<Parameter> pars = new ArrayList<>();
//        ticketPar.name("token").description("token")
//                .modelRef(new ModelRef("string")).parameterType("header")
//                .required(false).build(); //header中的token参数非必填，传空也可以
//        pars.add(ticketPar.build());    //根据每个方法名也知道当前方法在设置什么参数

        return new Docket(DocumentationType.SWAGGER_2)
                .alternateTypeRules(//解决返回对象为Map<String, List<VersionPushStatisticResp>>时，Swagger页面报错
                        AlternateTypeRules.newRule(
                                typeResolver.resolve(Map.class, String.class, typeResolver.resolve(List.class, VersionPushStatisticResp.class)),
                                typeResolver.resolve(Map.class, String.class, WildcardType.class), Ordered.HIGHEST_PRECEDENCE),
                        )
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.ltjh.adc.controller"))
                .paths(PathSelectors.any())
                .build()
//                .globalOperationParameters(pars)
                .apiInfo(new ApiInfoBuilder()
                        .title("接口文档")
                        .description("项目名")
                        .version("1.0.0")
                        .build());
    }


}

没错，重点就是加上alternateTypeRules进行解析。

关注公众号获取更多内容，有问题也可在公众号提问哦：