从 OpenAPI 规范生成代码，包括示例和描述

Question

假设我有一个具有以下属性的 OpenAPI 规范.yaml文件：

.... 
My_Model:
  description: 'Model to do some work'
  type: object
....

当我使用openapi-generator将其生成为 Kotlin 代码时，它会将描述添加到 Javadoc 部分：

/**
 * Model to do some work
 */

data class MyModel(
....

我想从生成器中将描述添加到 swagger 注释中（或仅）：

....
@Schema(description = "Model to do some work")
data class MyModel(
....

是否有任何设置或其他生成器库/软件支持此功能？ 相同的情况不仅适用于描述，而且适用于示例。 也需要为领域工作。

Answer 1

是的，您可以在 class 级别和属性级别中使用@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依赖关系：

使用 Gradle：

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 应用程序：

• https://www.davideaversa.it/blog/document-kotlin-spring-application-springdoc-openapi/
• https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-kotlin