Swagger2文档MongoDB ObjectId返回成JSON的问题

如题,项目集成了Swagger2生产文档,但是对于MongoDB的ObjectId类型文档生成了一个JSON格式,而接口实际返回的是一个24位字符串

Swagger2文档MongoDB ObjectId返回成JSON的问题

 

 Swagger2文档MongoDB ObjectId返回成JSON的问题

 

 首先想到了@ApiModelProperty注解的dataType,加上

@ApiModelProperty(value = "消息Id",dataType = "string")
    @Id
    private ObjectId msgId;// 消息Id

重新生成还是一样的,于是百度参考了《Swagger shows Mongo ObjectId as complex JSON instead of String》,在Swagger2的配置类中加上了类型转换 .directModelSubstitute(ObjectId.class, String.class)

return new Docket(DocumentationType.SWAGGER_2)
                //将ObjectId转换成string类型
                .directModelSubstitute(ObjectId.class, String.class)
                .enable(true)       //是否开启swagger
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.shiku.om"))//扫描接口的路径
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars)
                .apiInfo(apiInfo());

测试一波,还是不行,一看项目重写了Swagger的starter,于是在重写的代码中又加上了上面的类型转换。测试还是GG,尝试过升级Swagger版本,但是分布式项目太大,牵扯太多。

Swagger2文档MongoDB ObjectId返回成JSON的问题

 

 最后发现一个漏掉的注解类,反之没有这个问题,那么ObjectId字段就先去掉@ApiModelProperty吧

 

Swagger2文档MongoDB ObjectId返回成JSON的问题

上一篇:clickhouse-012之全量导出MySQL数据到clickhouse表


下一篇:Innodb数据页