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

Question

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

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

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

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

（招摇v3）

Answer 1

kotlin 中的解决方案：

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

Answer 2

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

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

谢谢@viktor-baert