從 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