Swagger将Mongo ObjectId显示为复杂的JSON而不是String

Question

我有一个Kotlin Spring Boot 2.0项目，它公开了一个返回MongoDB模型的@RestControllerAPI。例如，此模型和控制器：

@RestController
@RequestMapping("/api/accounts")
class AccountsController() {
    @GetMapping
    fun list(): List<Account> {
        return listOf(Account(ObjectId(), "Account 1"), Account(ObjectId(), "Account 2"), Account(ObjectId(), "Account 3"))
    }
}

@Document
data class Account(
        @Id val id: ObjectId? = null,
        val name: String
)

这些模型有ObjectId标识符，但在API中，我希望它们被视为普通String（即，而不是复杂的JSON，默认行为）。

为了实现这一点，我创建了以下组件来配置Spring Boot参数绑定和JSON解析：

@JsonComponent
class ObjectIdJsonSerializer : JsonSerializer<ObjectId>() {
    override fun serialize(value: ObjectId?, gen: JsonGenerator?, serializers: SerializerProvider?) {
        if (value == null || gen == null) return

        gen.writeString(value.toHexString())
    }
}

@JsonComponent
class ObjectIdJsonDeserializer : JsonDeserializer<ObjectId>() {
    override fun deserialize(p: JsonParser?, ctxt: DeserializationContext?): ObjectId? {
        if (p == null) return null

        val text = p.getCodec().readTree<TextNode>(p).textValue()
        return ObjectId(text)

    }
}

@Component
class StringToObjectIdConverter : Converter<String, ObjectId> {
    override fun convert(source: String): ObjectId? {
        return ObjectId(source)
    }
}

到目前为止，这一切都按预期进行，对API的调用将返回以下JSON：

[
  {
    "id": "5da454f4307b0a8b30838839",
    "name": "Account 1"
  },
  {
    "id": "5da454f4307b0a8b3083883a",
    "name": "Account 2"
  },
  {
    "id": "5da454f4307b0a8b3083883b",
    "name": "Account 3"
  }
]

在将Swagger集成到项目中时会出现问题，文档显示，调用此方法会返回一个复杂的JSON，而不是一个普通的String，作为id属性：

将@ApiModelProperty（dataType=“string”）添加到id字段没有任何区别，我无法找到一种方法来解决这个问题，而不将项目中的所有id字段更改为string。任何帮助都将不胜感激。

Answer 1

对于OpenApi（Swagger 3.0）和SpringDoc，可以使用以下全局配置。

static {
     SpringDocUtils.getConfig().replaceWithSchema(ObjectId.class, new StringSchema());
}

Answer 2

我无法让@ApiModelProperty（dataType = "")工作，但我发现了一种更方便的方法，即在Swagger配置中使用此响应中Docket实例的DirectModelSub0004方法配置直接替代品。

@Configuration
@EnableSwagger2
class SwaggerConfig() {
    @Bean
    fun api(): Docket {
        return Docket(DocumentationType.SWAGGER_2)
                .directModelSubstitute(ObjectId::class.java, String::class.java)
    }
}

Java等价物：

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .directModelSubstitute(ObjectId.class, String.class);
}