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

Question

我正在使用swagger-codegen来基于我的Web生成一个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-codegen配置为不生成标头的最后3行？

Answer 1

是的有可能。输出格式是使用胡子模板定义的。

在这里为您的语言找到模板：

• 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

下载要更改的模板，并根据需要修改它们。然后使用-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文件夹中找不到的模板将默认为标准模板。

示例

对于Codegen2.x (OAS2)中的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运行生成器，使用您的自定义模板而不使用该标头。