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

Question

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

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

在帖子/宠物中 在宠物回复中，状态的描述为“商店中的宠物状态”

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

（招摇v3）

Answer 1

import io.swagger.v3.oas.annotations.media.Schema;

public class Pet {
    @Schema(description = "Pet status in the store")
    private String status;
}

谢谢@viktor-baert

Answer 2

kotlin 中的解决方案：

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