Swagger Codegenの選択的生成

プロジェクト内の*すべての*モデルを生成したくない場合があります。同様に、1つか2つのAPIだけを生成したい場合もあります。その場合、システムプロパティを使用して出力を制御できます。

デフォルトでは、特定のライブラリでサポートされている*すべて*を生成します。一度機能を有効にすると、生成されるコンテンツが制限されます。

# generate only models
java -Dmodels {opts}

# generate only apis
java -Dapis {opts}

# generate only supporting files
java -DsupportingFiles

# generate models and supporting files
java -Dmodels -DsupportingFiles

生成する特定のファイルを制御するには、必要なもののCSVリストを渡します。

# generate the User and Pet models only
-Dmodels=User,Pet

# generate the User model and the supportingFile `StringUtil.java`:
-Dmodels=User -DsupportingFiles=StringUtil.java

APIおよびモデルのドキュメントとテストの生成を制御するには、オプションにfalseを渡します。APIの場合、これらのオプションは-DapiTests=falseと-DapiDocs=falseです。モデルの場合、-DmodelTests=falseと-DmodelDocs=falseです。これらのオプションはデフォルトでtrueであり、上記の機能オプション（-Dapiなど）の生成を制限しません。

# generate only models (with tests and documentation)
java -Dmodels {opts}

# generate only models (with tests but no documentation)
java -Dmodels -DmodelDocs=false {opts}

# generate only User and Pet models (no tests and no documentation)
java -Dmodels=User,Pet -DmodelTests=false {opts}

# generate only apis (without tests)
java -Dapis -DapiTests=false {opts}

# generate only apis (modelTests option is ignored)
java -Dapis -DmodelTests=false {opts}

選択的生成を使用する場合、特定の生成に必要なテンプレート*のみ*が使用されます。

無視ファイル形式

Swagger Codegenは、おそらくすでに使い慣れている.gitignoreや.dockerignoreと同様に、.swagger-codegen-ignoreファイルをサポートしています。

無視ファイルを使用すると、--skip-overwriteフラグよりも既存のファイルの上書きをより細かく制御できます。無視ファイルを使用すると、個々のファイルやディレクトリを無視するように指定できます。これは、たとえば、生成されたコードの一部だけが必要な場合に役立ちます。

例

# Swagger Codegen Ignore
# Lines beginning with a # are comments

# This should match build.sh located anywhere.
build.sh

# Matches build.sh in the root
/build.sh

# Exclude all recursively
docs/**

# Explicitly allow files excluded by other rules
!docs/UserApi.md

# Recursively exclude directories named Api
# You can't negate files below this directory.
src/**/Api/

# When this file is nested under /Api (excluded above),
# this rule is ignored because parent directory is excluded by previous rule.
!src/**/PetApiTests.cs

# Exclude a single, nested file explicitly
src/IO.Swagger.Test/Model/AnimalFarmTests.cs

.swagger-codegen-ignoreファイルは、出力ディレクトリのルートに存在する必要があります。

最初のコード生成時に、生成される出力をさらに制御するために、CLIオプション--ignore-file-override=/path/to/ignore_fileを渡すこともできます。これは完全な上書きであり、コードを再生成する際に出力ディレクトリ内の.swagger-codegen-ignoreファイルを上書きすることに注意してください。

.swagger-codegen-ignoreファイルのIntelliJでのエディターサポートは、.ignore pluginを介して利用できます。