如何解决从 OpenAPI 规范生成代码,包括示例和描述 对 springdoc-openapi-kotlin 的依赖:参考:
假设我有一个具有以下属性的 OpenAPI 规范 .yaml
文件:
....
My_Model:
description: 'Model to do some work'
type: object
....
当我将其生成为 Kotlin 代码时,使用 openapi-generator,它将描述添加到 Javadoc 部分:
/**
* Model to do some work
*/
data class MyModel(
....
我想要从生成器中添加描述到 swagger 注释 also(或 only):
....
@Schema(description = "Model to do some work")
data class MyModel(
....
是否有任何设置或其他生成器库/软件支持此功能? 同样的情况不仅适用于描述,也适用于示例。也需要为领域工作。
解决方法
是的,您可以在类级别和属性级别使用 @Schema
注释:
@Schema(name = "MyDto",description = "MyDto Model")
class MyDto {
@Schema(description = "Prop Description",example = "Prop Example")
var prop: String? = null
@Schema(description = "Text Description",example = "Text Example")
var text: String? = null
@Schema(description = "Something Description",example = "Something Example")
var something: String? = null
}
对 springdoc-openapi-kotlin
的依赖:
使用摇篮:
implementation("org.springdoc:springdoc-openapi-kotlin:1.5.9")
使用 Maven:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-kotlin</artifactId>
<version>1.5.9</version>
</dependency>
参考:
如何使用 Springdoc 和 OpenAI 记录 Kotlin/Spring 应用程序:
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。