コマンドおよびフラグの一般的な使用
API カタログ CLI をインストールして権限を設定したら、API カタログ CLI コマンドを使用して API を自動カタログ化できます。コマンドを実行するときに Anypoint Platform に対して認証するためのいくつかのオプションを使用できます。
API カタログコマンドのリスト
API カタログ CLI には次のコマンドが含まれます。
| コマンド | 説明 |
|---|---|
API カタログコマンドのオートコンプリートを設定します。 |
|
ログイン情報設定ファイルを作成または削除します。 |
|
記述子ファイルを作成します。 |
|
記述子ファイルを更新します。 |
|
Exchange にアセットをパブリッシュします。 |
コマンドヘルプを表示する
help オプションを使用して、コマンドまたはコマンドフラグとそれらの説明をリストします。次の例は、help オプションの使用方法を示しています。
api-catalog help api-catalog create-descriptor --help
一般フラグと認証フラグ
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。 |
-o, --output=output |
現在使用されていません。 |
-p, --password または ANYPOINT_PASSWORD 環境変数 |
Anypoint ユーザーパスワード。 「認証」を参照してください。 |
-u, --username=username または ANYPOINT_USERNAME 環境変数 |
Anypoint ユーザー名。 「認証」を参照してください。 |
認証
API カタログ CLI の実行中に Anypoint Platform に対して認証するには、次の認証の組み合わせのいずれかを使用する必要があります。
-
ユーザー名とパスワード
-
クライアント ID とクライアントシークレット
-
ベアラートークン (コマンドラインのみ)
デフォルト設定にログインする場合を除き、ホスト、環境、および組織も指定する必要があります。
次の方法を使用して、Anypoint Platform ログイン情報を渡すことができます。
設定は次のように上書きされます。
-
コマンドラインフラグはその他すべての方法を上書きする。
-
コマンドラインフラグが指定されていない場合は環境変数が使用され、ログイン情報設定ファイルの設定を上書きする。
-
コマンドラインフラグまたは環境変数が設定されていない場合、ログイン情報設定ファイルのオプションが使用される。
SSO
API カタログ CLI を実行しているシステムで SSO を使用するように Anypoint Platform を設定した場合、認証フラグなしで API カタログ CLI コマンドを実行すると、コマンドは SSO を介して Anypoint Platform にログインします。SSO を介したログインの設定についての詳細は、「ID 管理について」を参照してください。
ログイン情報設定ファイル
SSO を使用していない場合、ログイン情報を Anypoint Platform CLI インストールに渡す最も安全な方法は、ログイン情報設定ファイルを使用することです。
api-catalog conf コマンドを実行してログイン情報を設定ファイルに追加することで、Anypoint Platform に対して認証できます。有効なログイン情報を使用して設定ファイルを作成したら、ログイン情報フラグを指定することなく api-catalog コマンドを実行でき、設定ファイルの値を使用して認証が行われます。
次の認証キーの組み合わせを使用して、設定ファイルに認証値を設定できます。
username password client_id client_secret host environment organization
設定ファイルを作成するには、次の操作を実行します。
-
使用するキーと値のペアを指定して
api-catalog conf コマンドを実行する。たとえば、次のコマンドはユーザー名とパスワードを設定します。$ api-catalog conf username myuser $ api-catalog conf password mypwd
このコマンドは、次の場所にある config.json ファイルにログイン情報を保存します。
-
MacOS:
~/Library/Preferences/@mulesoft/api-catalog-cli-nodejs/config.json -
Windows:
%LOCALAPPDATA%\mycli -
Unix:
~/.config/mycli
例:
-
ベアラートークンの値を設定する
$ api-catalog conf bearer b71cab22-e5cc-43c4-90ed-5a1124b6ae1f
-
ユーザー名とパスワードの値を設定する
$ api-catalog conf username myuser $ api-catalog conf password mypwd
-
特定のホスト、組織、および環境の値を設定する
$ api-catalog conf host myco.anypoint.mulesoft.com $ api-catalog conf environment ec7d16cb-43fd-4796-8b4f-5cff7294fcf9 $ api-catalog conf organization 8a840abc-e63a-4f8d-87ad-24052eda3018
-
クライアント ID とクライアントシークレットの値を設定する
$ api-catalog conf client_id myClientID $ api-catalog conf client_secret myCLientSecret
上記のコマンドを実行した後の config.json コンテンツの例:
{
"bearer": "b71cab22-e5cc-43c4-90ed-5a1124b6ae1f",
"username": "myuser",
"password": "mypwd",
"host": "myco.anypoint.mulesoft.com",
"environment": "ec7d16cb-43fd-4796-8b4f-5cff7294fcf9",
"organization": "8a840abc-e63a-4f8d-87ad-24052eda3018",
"client_id": "1787c36ab544466698e380131040faad",
"client_secret": "2dA616efca1E4181A2A77BBF046868BE"
}
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 コマンドを実行することで、コマンドラインから Anypoint Platform に対して認証できます。
--username --password --client_id --client_secret --bearer --organization --environment
例:
-
ユーザー名とパスワードを使用してコマンドラインで認証する
$ api-catalog --username myUserName --password myPassword --organization=myOrgId publish-asset
-
クライアント ID とクライアントシークレットを使用してコマンドラインで認証する
$ api-catalog --client_id myClientID myClientSecret --organization=myOrgId publish-asset
-
ベアラートークンを使用してコマンドラインで認証する
Anypoint Platform でベアラートークンを生成し、API カタログ CLI に直接渡すことができます。ベアラートークンを提供した場合、API カタログ CLI は他に提供されているすべてのユーザーログイン情報やクライアントログイン情報を無視します。
$ api-catalog --bearer myBearerToken --organization=myOrgId publish-asset
ベアラートークンの有効期限が切れると、Anypoint Platform セッションの有効期限が切れます。
ベアラートークンの生成については、 「How to Generate Your Authorization Bearer Token for Anypoint Platform (Anypoint Platform 用の認証ベアラートークンの生成方法)」を参照してください。
環境変数
api-catalog コマンドを実行する前に、次の環境変数の組み合わせを設定することで、Anypoint Platform に対して認証できます。
ANYPOINT_USERNAME ANYPOINT_PASSWORD ANYPOINT_CLIENT_ID ANYPOINT_CLIENT_SECRET ANYPOINT_ORG ANYPOINT_ENV ANYPOINT_HOST
例:
-
ユーザー名とパスワードの環境変数を設定して認証する
$ export ANYPOINT_USERNAME=myUserName $ export ANYPOINT_PASSWORD=myPassword $ export ANYPOINT_ORG=myOrgId
-
クライアント ID とクライアントシークレットの環境変数を設定して認証する
$ export ANYPOINT_CLIENT_ID=myClientID $ export ANYPOINT_CLIENT_SECRET=myCLientSecret $ export ANYPOINT_ORG=myOrgId