是否可以配置由 swagger-codegen 生成的源代码文件头？

Question

我正在使用 swagger-codegen 基于我的 Web API 生成 SDK，生成的源文件包含以下标头：

/* 
 * [MY PROJECT NAME]
 *
 * [MY COPYRIGHT]
 *
 * OpenAPI spec version: 1.0.0 - Beta
 * Contact: [MY EMAIL]
 * Generated by: https://github.com/swagger-api/swagger-codegen.git
 */

是否可以配置swagger-codecen以不生成标头的最后3行？

Answer 1

是的，这是可能的。输出格式是使用Mustache模板定义的。

在此处查找您的语言模板：

• Codegen 2.x （OAS2）： https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen/src/main/resources
• Codegen 3.x （OAS3）： https://github.com/swagger-api/swagger-codegen-generators/tree/master/src/main/resources

下载要更改的模板，并根据需要进行修改。然后使用< code>-t参数运行生成器，指定自定义模板的路径:

java -jar swagger-codegen-cli-2-4-18.jar generate
  -i http://petstore.swagger.io/v2/swagger.json
  -l csharp
  -o PetstoreCSharpClient
  -t path/to/MyTemplates    <------

将使用-t文件夹中的任何自定义模板，而不是相应的标准模板。在-t文件夹中未找到的模板将默认为标准模板。

对于Codegen 2.x (OAS2)中的< code>csharp生成器，有问题的头来自:

modules/swagger-codegen/src/main/resources/csharp/partial_header.mustache

并且有类似的标题：

modules/swagger-codegen/src/main/resources/csharp/Project.mustache
modules/swagger-codegen/src/main/resources/csharp/TestProject.mustache

将这 3 个文件下载到 C：\MyTemplates，并从中删除不需要的行。然后使用 -t C：\MyTemplates 运行生成器，以使用没有该标头的自定义模板。