spring-boot - 如何使用 swagger OpenAPI 注释将描述设置为字段

Question

为了改进我们的 api 文档，我想在响应正文的字段中添加描述

作为示例，请参阅此处的默认 petstore 规范:https://editor.swagger.io/

在 POST/pet在宠物响应中，状态有描述“商店中的宠物状态”

如何在我的代码库中从注释的角度做到这一点？

(swagger v3)

Answer 1

kotlin 中的解决方案:

data class Pet(
        @field:Schema(description = "Pet status in the store")
        val status: String
     )