Swagger Codegen ジェネレーター

デフォルトのジェネレーター設定が要件を満たさない場合、既存のモジュールやテンプレートを変更したり、新しいモジュールやテンプレートを作成したりするためのさまざまなオプションがあります。

クライアントライブラリのフォーマットを変更する

デフォルトのswaggerクライアントの構文が気に入らない？別の言語がサポートされていることを希望しますか？問題ありません！Swagger Codegenは、jmustacheエンジンでMustacheテンプレートを処理します。当社のテンプレートを修正したり、独自のテンプレートを作成したりできます。

例については、modules/swagger-codegen/src/main/resources/${your-language}をご覧ください。独自のテンプレートを作成するには、独自のファイルを作成し、-tフラグを使用してテンプレートフォルダを指定します。実際に、それほど簡単です。

独自のコード生成モジュールを作成する

新しい言語でプロジェクトを開始し、必要なものが見つからない場合、Swagger Codegenは独自のライブラリを生成するためのプロジェクトを作成するのに役立ちます

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \
  -o output/myLibrary -n myClientCodegen -p com.my.company.codegen

これにより、output/myLibraryフォルダに、README.mdを含む、開始に必要なすべてのファイルが書き込まれます。変更およびコンパイルが完了したら、codegenでライブラリをロードし、独自のカスタムロジックでクライアントを生成できます。

output/myLibraryフォルダでmvn packageを使用してライブラリをコンパイルし、次のようにcodegenを実行します。

java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen

Windowsユーザーの場合、クラスパスでは:の代わりに;を使用する必要があります。例：

java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar;modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen

myClientCodegenがオプションになり、ライブラリの生成に通常の引数を使用できることに注意してください。

java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar \
  io.swagger.codegen.SwaggerCodegen generate -l myClientCodegen\
  -i https://petstore.swagger.io/v2/swagger.json \
  -o myClient

「スタンドアロンジェネレーター開発」も参照してください。

ローカルファイルからクライアントを生成する

サーバーを呼び出したくない場合は、OpenAPI Specファイルをディレクトリに保存し、次のようにコードジェネレーターに引数を渡すことができます。

-i ./modules/swagger-codegen/src/test/resources/2_0/petstore.json

CIサーバーでライブラリを作成する場合、Swagger Editorから作成する場合、または飛行機でコーディングする場合に最適です✈️。

無視ファイルのフォーマット

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プラグインを通じて利用できます。