1. Homepage
  2. Anypoint CLI (4.x)

  3. API Catalog (API カタログ)

API Catalog (API カタログ)

コマンド 説明

api-catalog autocomplete

API カタログコマンドのオートコンプリートを設定します。

api-catalog conf

ログイン情報設定ファイルを作成または削除します。

api-catalog create-descriptor

記述子ファイルを作成します。

api-catalog update-descriptor​

記述子ファイルを更新します。

api-catalog publish-asset

Exchange にアセットをパブリッシュします。

api-catalog autocomplete

$ api-catalog autocomplete [flags]

このコマンドは、次のフラグを受け入れます。

フラグ 説明

blank

オートコンプリートの設定手順を表示します。

bash

Bash シェル設定を使用してオートコンプリートをインストールします。

zsh

Z シェル設定を使用してオートコンプリートをインストールします。

-r, --refresh cache

現在のオートコンプリート設定を削除します。これは、別のシェル種別でコマンドを実行する前に使用します。

例

$ api-catalog autocomplete
$ api-catalog autocomplete bash
$ api-catalog autocomplete zsh
$ api-catalog autocomplete --refresh-cache
現時点では、API Catalog CLI オートコンプリートプラグインは、Windows ではサポートされていません。

api-catalog conf

キーと値のペアを追加および削除して、設定ファイル (config.json) で認証ログイン情報を管理します。コマンドの実行ごとに 1 つのキーと値のペアを設定します。

> api-catalog conf <authkey> <authkeyvalue> [flags]

<authkey>
認証キー名。使用可能なキー名: username password client_id client_secret host environment organization

<authkeyvalue>
指定された認証キーの値。

このコマンドは、次のフラグを受け入れます。

フラグ 説明

-d, ​--delete

指定されたキーの設定ファイルエントリを削除します。

-h, ​--help

コマンドのヘルプを表示します。

-k, ​--key=key

指定されたキーに対応する値を表示します。

-v, ​--value=value

指定された値に対応するキーを表示します。

api-catalog create-descriptor

> api-catalog create-descriptor [flags]

このコマンドは、次のフラグを受け入れます。

フラグ 説明

-d, ​--file=file

デフォルト: catalog.yaml​

生成されたカタログ記述子ファイルを保存する名前と場所。

--external

記述子ファイルに記述されている API ごとに ​exchange.json​ ファイルを生成し、​projects​ セクションの ​ref​ タグを使用して記述子ファイル内の各 API への参照を追加します。

api-catalog update-descriptor

> api-catalog update-descriptor [flags]

このコマンドは、次のフラグを受け入れます。

フラグ 説明

-d, ​--descriptor-file=descriptor-file

デフォルト: catalog.yaml​

更新されたカタログ記述子ファイル情報を保存する名前と場所。

api-catalog publish-asset

> api-catalog publish-asset [flags]

このコマンドは、次のフラグに加えて、​一般フラグと認証フラグ​を受け入れます。

フラグ 説明

--async

パブリッシュジョブを非同期で実行します。

-d, ​--descriptor-file=descriptor-file

または

ANYPOINT_DESCRIPTOR_FILE​ 環境変数

デフォルト: ./catalog.yaml

カタログ記述子ファイルの名前と場所。

  • ファイルが存在しない場合、アセットはカタログ化されません。

  • ファイルが存在しても空の場合、このコマンドはカタログ記述子 YAML の結果を作成して出力します。現在の作業ディレクトリに関連する完全なディレクトリツリーで見つかったすべての API 定義のカタログ情報を出力します。

  • 有効な YAML ファイルが存在する場合、このコマンドはアセットを指定されたとおりにカタログ化します。

​「CLI を使用した記述子ファイルの作成」​を参照してください。

--dry-run

コマンドを実行して、記述子ファイルが有効であることを確認します。API はパブリッシュされません。

--force-publish

比較せずに、コンテンツに関係なく Exchange に新しいバージョンのアセットを作成します。

--force-update-metadata

コンテンツに関係なく、タグなどのアセットのメタデータを Exchange の最新バージョンに更新します。アセットは再パブリッシュされません。

--json

実行結果を JSON 形式で出力します。

-s, ​--silent

サイレントログを有効にします。

-t, ​--trigger-criteria=<descriptor-tag>:<value> ​--trigger-criteria=<descriptor-tag>:value

このフラグは、記述子ファイルの ​triggerConditions​ セクションと連携して機能します。​api-catalog publish-asset​ コマンドを実行するたびに、トリガー値が記述子ファイルのトリガー条件値と比較され、記述子ファイルに記述されている API をパブリッシュするかどうかが決定されます。複数の条件と照合するには、条件ごとに個別の ​--trigger-criteria​ フラグを指定します。API をパブリッシュするには、記述子ファイルに設定されたすべてのトリガー条件が ​--trigger-criteria​ フラグ値で照合される必要があります。

例:

--trigger-criteria=branch:main --trigger-criteria=anytag:release/ --trigger=user:admin

「記述子 YAML スキーマ」​を参照してください。

-v, ​--verbose

冗長ログを有効にします。

--version-strategy-criteria=<descriptor-tag>:<value>

このフラグは、記述子ファイルの ​versionStrategyConditions​ セクションと連携して機能します。​api-catalog publish-asset​ コマンドは、バージョン戦略条件値を記述子ファイル内のバージョン戦略条件値と比較して、API のパブリッシュに使用するバージョン戦略を決定します。複数の条件と照合するには、条件ごとに個別の ​--version-strategy-criteria​ フラグを指定します。

例:

--version-strategy-criteria=branch:main --version-strategy-criteria=anytag:release/ --version-strategy-criteria=user:admin

「記述子 YAML スキーマ」​を参照してください。

一般フラグと認証フラグ

Anypoint Platform に対して認証するコマンドの一般フラグと認証フラグを次に示します。

フラグ 説明

--client_id=client_id​

または

ANYPOINT_CLIENT_ID​ 環境変数

接続アプリケーションクライアント ID。

「認証」​を参照してください。

--client_secret​

または

ANYPOINT_CLIENT_SECRET​ 環境変数

クライアント ID の接続アプリケーションシークレットのプロンプト。

​「認証」​を参照してください。

--collectMetrics​

または

COLLECT_METRICS​ 環境変数

現在使用されていません。

--environment=environment​

または

ANYPOINT_ENV​ 環境変数

API がカタログ化されている Anypoint Platform 環境の名前。

--host=host

または

ANYPOINT_HOST​ 環境変数

デフォルト:

anypoint.mulesoft.com

プロトコルなしの Anypoint Platform ベース URL。

US Anypoint Platform の場合、次を使用します。

anypoint.mulesoft.com

ヨーロッパの Anypoint Platform の場合、次を使用します。

eu1.anypoint.mulesoft.com

--organization=organization​

または

ANYPOINT_ORG​ 環境変数

API がカタログ化されている Anypoint Platform 組織の ID。

-p, ​--password​

または

ANYPOINT_PASSWORD​ 環境変数

Anypoint ユーザーパスワード。

​「認証」​を参照してください。

-u, ​--username=username​

または

ANYPOINT_USERNAME​ 環境変数

Anypoint ユーザー名。

「認証」​を参照してください。