OpenAPI: openapi-generator-cli¶
OpenAPI Generator は、OpenAPI で記述した仕様を元にソースコードやドキュメントを自動生成するツールです。
openapi-generator-cli は OpenAPI Generator のランチャーであり、実行時に OpenAPI Generator 本体をダウンロードして実行します。実際に使用する OpenAPI Generator のバージョンは実行時に指定することができます。
同名のツールですが Bash 版と JavaScript 版があり、使い方に若干違いがあるため混乱しました。注意しましょう!
JavaScript 版¶
- CLI Installation
npm install -g @openapitools/openapi-generator-cli
等でインストール- 実行時ディレクトリにある openapitools.json ファイルで OpenAPI Generator のバージョンを指定 (未指定時は最新版)
openapi-generator-cli version-manager
コマンドで openapitools.json ファイルを生成・設定できる
- node_modules/@openapitools/openapi-generator-cli/versions/ 配下に本体(jar ファイル)がダウンロードされる
OpenAPI Geneator のバージョンを指定して実行する例
openapi-generator-cli version-manager set 6.2.1
openapi-generator-cli ...
Bash 版¶
- Bash Launcher Script - CLI Installation
- 単一の Bash スクリプト
- 環境変数で OpenAPI Generator のバージョンを指定 (未指定時は最新版)
- openapi-generator-cli のあるパスに本体(jar ファイル)がダウンロードされる
OpenAPI Geneator のバージョンを指定して実行する例
OPENAPI_GENERATOR_VERSION=6.2.1 openapi-generator-cli ...