Swagger Codegen 生成器配置

除了创建或修改模板之外，代码生成器还有不同的定制方面。每种语言都有一个支持配置文件来处理不同的类型映射等。

1
$ ls -1 modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/
2
AbstractJavaJAXRSServerCodegen.java
3
AbstractTypeScriptClientCodegen.java
4
... (results omitted)
5
TypeScriptAngularClientCodegen.java
6
TypeScriptNodeClientCodegen.java

这些文件都创建了合理的默认值，以便您快速运行。但如果您想配置包名、前缀、模型文件夹等，可以使用 JSON 配置文件来传递这些值。

1
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
2
  -i https://petstore.swagger.io/v2/swagger.json \
3
  -l java \
4
  -o samples/client/petstore/java \
5
  -c path/to/config.json

并且 config.json 包含以下示例内容

1
{
2
  "apiPackage" : "petstore"
3
}

支持的配置选项可能因语言而异。运行 config-help -l {lang} 将显示可用选项。这些选项可以通过配置文件（例如 config.json）应用，或通过 java -jar swagger-codegen-cli.jar -D{optionName}={optionValue} 传递。

如果 -D{optionName} 不起作用，请提交一张工单，我们将调查此问题。

1
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java

输出

1
CONFIG OPTIONS
2
modelPackage
3
    package for generated models
4

5
apiPackage
6
    package for generated api classes
7
...... (results omitted)
8
library
9
    library template (sub-template) to use:
10
    jersey1 - HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2
11
    jersey2 - HTTP client: Jersey client 2.6
12
    feign - HTTP client: Netflix Feign 8.1.1.  JSON processing: Jackson 2.6.3
13
    okhttp-gson (default) - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1
14
    retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)
15
    retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2)
16
    google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9
17
    rest-assured - HTTP client: rest-assured : 3.1.0. JSON processing: Gson 2.6.1. Only for Java8

您的 Java 配置文件可能如下所示

1
{
2
  "groupId": "com.my.company",
3
  "artifactId": "MyClient",
4
  "artifactVersion": "1.2.0",
5
  "library": "feign"
6
}

对于所有未指定的选项，将使用默认值。

覆盖默认选项的另一种方法是扩展特定语言的配置类。例如，要更改 Objective-C 生成文件的前缀，只需继承 ObjcClientCodegen.java 类即可。

1
package com.mycompany.swagger.codegen;
2

3
import io.swagger.codegen.languages.*;
4

5
public class MyObjcCodegen extends ObjcClientCodegen {
6
    static {
7
        PREFIX = "HELO";
8
    }
9
}

并在运行生成器时指定 classname

1
-l com.mycompany.swagger.codegen.MyObjcCodegen

您的子类现在将被加载并覆盖父类中的 PREFIX 值。

引入您自己的模型

有时您不希望生成某个模型。在这种情况下，您只需指定一个导入映射来告诉代码生成器*不*创建什么。这样做时，引用特定模型的每个位置都将引用回您的类。请注意，这可能不适用于所有语言...

要指定导入映射，请使用 --import-mappings 参数并按如下方式指定模型到导入的逻辑

1
--import-mappings Pet=my.models.MyPet

或用于多个映射

1
--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder

或

1
--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder