API カタログ CLI の入門

API カタログ CLI、および​「API カタログ CLI を使用した自動カタログ化」​で説明されている概念を把握したら、API の自動カタログ化を開始できます。

始める前に

Anypoint Platform とやりとりする API カタログ CLI コマンドを実行する権限を付与します。

  • API カタログコントリビューター​を有効にします。

  • 接続アプリケーションを使用して認証する場合、​View Environment​ スコープを組織のメイン環境に設定します。

権限は、管理者権限を持つ Anypoint Platform ユーザーが ​[Access Management (アクセス管理)]​ で設定する必要があります。

権限の管理​についての詳細は、アクセス管理のドキュメントを参照してください。

API カタログ CLI の使用を開始する

API カタログ CLI の使用を開始する手順は、次のとおりです。

  1. API カタログ CLI を​インストール​します。

  2. 認証情報を渡す方法や一般的なコマンドフラグを使用する方法など、​API カタログの一般的な使用を理解​します。

  3. 記述子ファイルを作成​して、パブリッシュする API を識別します。

  4. API カタログ CLI を使用して​アセットをカタログ化​し、Anypoint Exchange で表示します。

コマンドを CI/CD パイプラインまたはカスタムスクリプトに追加する前に、コマンドプロンプトでコマンドを実行して、プロセスのエンドツーエンドをローカルでテストすることを検討してください。