Bundle and validate OpenAPI files into one publishable spec with swagger-cli
マルチファイルのOpenAPI定義を解決し、ドキュメント生成、コード生成、CIゲートの前に単一の検証済みアーティファクトにまとめます。
前提条件
Node.js、npmまたはnpx、必要に応じてローカルまたはリモートの$refターゲットを持つ1つ以上のSwagger/OpenAPI JSONまたはYAMLファイルが必要です。
インストール
環境に合わせて、アップストリームのインストールまたはセットアップパスを使用してください。
- npm install -g @apidevtools/swagger-cli
- git clone https://github.com/APIDevTools/swagger-cli.git
- npm install
- npm test
アップストリームからの要件と注意事項:
- pre-commitと呼ばれる便利なPythonツールがあり、広範なプリコミットチェックを実行できます。swagger-cli validateコマンドは、gitプリコミットの一部として統合できます...
基本的な使用方法または開始手順:
-
bash
-
swagger-cli [options]
-
アップストリームドキュメントから抽出: https://raw.githubusercontent.com/APIDevTools/swagger-cli/HEAD/README.md