微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

如何解决如何使用 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
     )

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。