API カタログ CLI を使用した API の自動カタログ化
API カタログ CLI を使用すると、自動化プロセスの一部として、API 定義、ドキュメントファイル、および関連するメタデータを検出してカタログ化できます。CI/CD パイプラインやカスタムスクリプトなどの自動化ツールにアセットのパブリッシュコマンドを組み込んで、Exchange への API アセットのパブリッシュを自動的にトリガーできます。API カタログ CLI は、CI/CD ツールとランタイム環境に依存しません。
API カタログ CLI では、次の作業を行うことができます。
-
プロジェクトディレクトリ構造内のすべての API を特定し、API を Exchange にパブリッシュするために使用する記述子ファイルを作成する。
-
すべての新規および変更された API を特定し、記述子ファイルを継続的に更新する。
-
分岐やタグなどの条件に基づいて、パブリッシュを条件に応じてトリガーする。
-
分岐やタグなどの条件に基づいて、アセットバージョン戦略を条件に応じて設定する。
-
コマンドプロンプトでコマンドを実行するか、CI/CD パイプラインまたはカスタムスクリプトの一部としてコマンドを実行することで、記述子ファイルに記述されている API をパブリッシュする。
サポート対象 API
API カタログ CLI では、以下がサポートされます。
-
イベント駆動型 API (AsyncAPI 2.0 JSON および AsyncAPI 2.0 YAML 形式)
-
REST API (OAS 2.0 JSON、OAS 2.0 YAML、OAS 3.0 JSON、OAS 3.0 YAML、RAML 0.8、および RAML 1.0 形式)
API カタログ CLI の概念
API カタログ CLI を使用する前に、次の概念を確認してください。
記述子ファイル
記述子ファイルには、Exchange がディレクトリとそのサブディレクトリ構造内の一連の API をカタログ化するために必要なメタデータが含まれています。このファイルのスキーマは、API カタログ CLI に固有のメタデータをサポートし、exchange.json ファイルのインラインまたは参照メタデータを含めることができます。