是否可以配置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-codegen 配置为不生成标题的最后 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

下载您要更改的模板并根据需要对其进行修改。 然后使用-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) 中的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运行生成器以使用没有该标题的自定义模板。