如何使用 swagger OpenAPI 注释为字段设置描述

问题描述

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

作为示例，请参阅此处的默认宠物商店规范：https://editor.swagger.io/

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

如何从代码库中的注释角度执行此操作？

(swagger v3)

解决方法

kotlin 中的解决方案：

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