codegen的模板檔案mustache中，classname，description，notes如何賦值

木头左發表於2024-04-15
賦值

Swagger-codegen的模板檔案mustache

Swagger-codegen是一個開源的程式碼生成工具，它可以根據Swagger規範自動生成客戶端和伺服器端程式碼。在使用Swagger-codegen時，我們可以透過mustache模板檔案來自定義生成的程式碼。在這篇文章中，我們將介紹如何在mustache模板檔案中給classname、description和notes賦值。

classname

classname是生成的Java類的名稱，它通常是根據Swagger規範中的API路徑和操作名稱生成的。在mustache模板檔案中，我們可以透過{{classname}}來引用它。如果我們想要自定義classname，可以在Swagger規範中的API操作中使用x-swagger-codegen-classname擴充套件屬性。例如：

paths:
  /users:
    get:
      x-swagger-codegen-classname: UserApi
      ...

在mustache模板檔案中，我們可以這樣使用：

public class {{classname}} {
  ...
}
description

description是Swagger規範中API操作的描述資訊，它通常用於生成文件。在mustache模板檔案中，我們可以透過{{description}}來引用它。例如：

/**
 * {{description}}
 */
public class {{classname}} {
  ...
}
notes

notes是Swagger規範中API操作的註釋資訊，它也通常用於生成文件。在mustache模板檔案中，我們可以透過{{notes}}來引用它。例如：

/**
 * {{description}}
 *
 * {{notes}}
 */
public class {{classname}} {
  ...
}

以上就是如何在Swagger-codegen的mustache模板檔案中給classname、description和notes賦值的方法。希望對大家有所幫助。

相關文章