Toolkit コマンドの要約
IBM® API Connect デベロッパーズ・ツールキットの中核となるコマンドの要約です。
コマンド・ライン・ツール・ヘルプの表示
コマンド・ラインの総合的なヘルプ情報を表示するには、コマンド apic --help または apic -h を入力します。特定の apic コマンドのヘルプ情報を表示するには、コマンド apic command_name --help または apic command_name -h を入力します。
バージョン情報の表示
コマンド・ライン・ツールのバージョンを表示するには、コマンド apic --version または apic -v を入力します。すべてのコマンド・ライン・ツール用プラグイン・モジュールのバージョンを含む詳細なバージョン情報を表示するには、コマンド apic --ext-version を入力します。
stability コマンド
一部のコマンドは、コマンドのヘルプ・テキストで Stability: prototype として識別されます (このトピックの後の方で示す表を参照)。これらのコマンドは実稼働環境用のコマンドではなく、テストとお客様からのフィードバックを目的としたコマンドです。これらのコマンドの構文と機能は、実稼働環境用としてリリースされる前に変更される可能性があります。
認証
構成変数の使用
ローカル構成変数の値は、project-root/.apiconnect/config ファイルに格納されます。ここで、project-root はプロジェクト・ルート・ディレクトリーです。グローバル構成変数の値は、user-home-dir/.apiconnect/config ファイルに格納されます。ここで、user-home-dir はユーザーのホーム・ディレクトリーです。
構成変数を処理するには、次のコマンドを使用します。
- apic config:get varname - 構成変数を取得します。すべてのローカル構成変数の値を表示するには、apic config を使用します。また、すべてのグローバル構成変数の値を表示するには、apic config -g を使用します。
- apic config:set varname - 指定された構成変数を設定または更新します。
- apic config:delete varname - 指定された構成変数を削除します。
- apic config:clear - すべての構成変数を削除します。
apic config:set コマンドを使用することで、構成プロパティーの値を設定します。catalog や app などの構成プロパティーを設定しておくと、コマンドを入力する際に、これらのプロパティーの値を指定する必要がなくなります。
以下の表に、構成変数を示します。
変数名 | 説明 | 次のオプションの代わりに使用 (または次のオプションでオーバーライド) |
---|---|---|
accessibility-mode | アクセシビリティー・モードを有効にします。アクセシビリティー機能を有効にするには enabled に設定します。アクセシビリティー機能は、視覚に制限があるユーザーが容易にツールを使えるようにするためのものです。 | 該当なし |
app | アプリケーションの局面を管理するすべてのコマンドのデフォルトのアプリケーション URI。 形式: apic-app://mgmt-server/orgs/org-name/apps/app-name。ここで、mgmt-server は管理サーバー、org-name は組織名、app-name はカタログ名です。 |
--app |
catalog | カタログの局面を管理するすべてのコマンドのデフォルトのカタログ URI。 形式: apic-catalog://mgmt-server/orgs/org-name/catalogs/catalog-name。ここで、mgmt-server は管理サーバー、org-name は組織名、catalog-name はカタログ名です。 注: カタログ名 apic-dev はローカルのテスト用に予約されています。
|
--catalog |
log-level | ローカル・アプリケーションおよび Micro Gateway のロギング詳細のレベル。次のいずれかでなければなりません。
|
該当なし |
org | 組織を管理するすべてのコマンドのデフォルトの組織 URI。 形式: apic-org://mgmt-server/orgs/org-name。ここで、mgmt-server は管理サーバー、org-name は組織名です。 mgmt-server 部分は、--server オプションのデフォルト値を設定します。 サーバー名にポート番号を追加できます (ポート番号がデフォルト値の 443 ではない場合)。 |
--organization、--server |
space | スペースの局面を管理するすべてのコマンドのデフォルトのスペース URI。 形式: apic-space://mgmt-server/orgs/org-name/catalogs/catalog-name/spaces/space-name。ここで、mgmt-server は管理サーバー、org-name は組織名、catalog-name はカタログ名、space-name はスペース名です。 サーバー名にポート番号を追加できます (ポート番号がデフォルト値の 443 ではない場合)。 |
--server、--organization、--catalog、--space |
template-default-api | 使用するデフォルトの API テンプレート。Handlebars (.hbs) ファイルの基本ファイル名を指定します。 | --template |
template-default-product | 使用するデフォルトの製品テンプレート。Handlebars (.hbs) ファイルの基本ファイル名を指定します。 | --template |
template-path | Handlebars テンプレートを含む絶対ローカル・ディレクトリー・パスのスペース区切りリスト。 | --template |
apic config:set name=value
ここで、name は構成プロパティーの名前であり、value は、その構成プロパティーに割り当てる値です。以下に例を示します。
apic config:set catalog=apic-catalog://mgmtnhost.com/orgs/climbon/catalogs/sb
TLS 証明書を使用するようにツールキットのコマンド・ライン・ツールを構成する
API Manager は、TLS プロファイルを使用してデータ伝送を保護します。API Manager での TLS プロファイルの作成方法について詳しくは、『TLS プロファイル』を参照してください。
TLS プロファイルが有効になっている API Manager と通信するために証明書を使用するようにツールキットのコマンド・ライン・ツールを構成するには、以下の手順に従います。
- 次のコマンドを入力することで、trust-store 構成変数を、TLS プロファイルのサーバーのトラストストアで使用される証明書ファイルの名前に設定します。
ここで、<cert-file> は TLS 証明書ファイルへの絶対ファイル・パスです。apic config:set trust-store=<cert-file>
- 次のコマンドを入力して、NODE_EXTRA_CA_CERTS 環境変数の値を設定し、ノードの組み込みの CA 証明書ストアを拡張します。
ここで、<cert-file> は TLS 証明書ファイルへの絶対ファイル・パスです。export NODE_EXTRA_CA_CERTS=<cert-file>
NODE_EXTRA_CA_CERTS 環境変数について詳しくは、Node.js の資料を参照してください。
ローカル・ファイルの作成と管理
API および製品の定義の YAML ファイルを API Manager にステージングするには、その前にローカルでこれらのファイルを作成および操作します。
ローカルの API 定義ファイルを作成するには、apic create --type api コマンドを使用します。 ローカルの製品定義ファイルを作成するには、apic create --type product コマンドを使用します。
API Manager の特定のタイプの成果物をリストするには、apic apis コマンドと apic products コマンドを使用します。
ローカルの API 定義ファイルまたは製品定義ファイルの構文の正しさを検証するには、apic validate コマンドを使用します。
ローカルの API 定義ファイルまたは製品定義ファイルから API Manager にドラフト API またはドラフト製品を作成するには、apic drafts:push コマンドを使用します。
ローカルで定義されたアプリケーション、製品、参照先 API を API Manager のカタログにステージングして公開するには、apic publish コマンドと apic apps:publish コマンドを使用します。
apic publish --scope space product.yaml --space space --catalog catalog --organization organization --server server
説明:- product は公開する製品の名前です。
- space は、公開対象のスペースの名前です。
- catalog は、スペースが含まれるカタログの名前です。
- organization は組織の名前です。
- server は管理サーバーであり、port の番号はオプションです (デフォルトは 443) です。
スクリプト・コマンド
apic --accept-license
このコマンドを実行すると、スクリプトを非対話式に実行できるようになります。apic --disable-analytics
API Manager 項目のリスト
apic apps
apic catalogs
apic drafts
apic orgs
apic props
apic services
apic spaces
apic extensions
ドラフトでの作業
ドラフト API とドラフト製品を直接操作するには、apic drafts:action コマンドを使用します。action は、実行するアクションです。例えば、ドラフト製品、およびその参照ドラフト API をカタログに公開するには、apic drafts:publish コマンドを使用します。
ドラフトの API または製品からローカルの API 定義ファイルまたは製品定義ファイルを作成するには、apic drafts:pull コマンドを使用します。
すべてのドラフト API またはドラフト製品からローカルの API 定義ファイルまたは製品定義ファイルを作成するには、apic drafts:clone コマンドを使用します。
スペース でのカタログの処理
カタログを作成するには、apic catalog:create コマンドを使用します。カタログに関する情報を表示するには、apic catalog:get コマンドを使用します。現在認証されているユーザーがメンバーである組織に含まれているすべてのカタログをリストするには、apic catalogs コマンドを使用します。
1 つのカタログ内で複数のチームが製品および API を独立して管理できるように、スペース を使用してカタログを区分化できます。スペースは、概念的にはサブカタログのようなものですが、同じカタログ内のすべてのスペースの製品および API は同じ開発者ポータルに公開されるという特徴があります。スペースについて詳しくは、IBM API Connect でのシンジケーションの使用を参照してください。
apic catalogs:set catalog_name --spaces enabled
- apic spaces - カタログに含まれているスペースをリストします。
- apic:spaces create - カタログ内のスペースを作成します。
- apic:spaces get - カタログ内のスペースに関する情報を取得します。
- apic:spaces set - カタログ内のスペースに関する情報を設定します。
- apic:spaces delete - カタログ内のスペースを削除します。
カタログまたはスペース内の製品、アプリケーション、および API を直接操作するには、apic products、apic apps、および apic apis の各コマンドを使用します。例えば、製品を更新するには apic products:set コマンドを使用します。操作対象のスペースを指定する必要がある場合は、コマンドに --scope space オプションを含める必要があります。
コマンドの要約
apic command:sub-command [argument] [options]
command は、config などのコマンド、sub-command は、get などのサブコマンド (指定される場合)、argument は、catalog などの引数 (指定される場合)、options は、--local などの 1 つ以上のオプション (指定される場合) です。サブコマンドや引数のない apic コマンドもあります。また、オプションを指定しなければならないコマンドもあります。すべてを指定した場合のコマンドは、以下の例のようになります。apic config:get catalog --local
apic create --type sub-command [options]
以下の表の一部のコマンドには Stability: prototype という注釈が付けられています。これは、IBM がコマンドに関するフィードバックをお客様から収集中であることを示しています。そのため、実動スクリプトでは使用しないでください。
apic create --type [api | product] --template template_filename --title new_title
ここで、template_filename は、使用する Handlebars テンプレートの名前です。テンプレートには、.hbs ファイル名拡張子が必要です。あるいは、対話式に API または製品を作成してテンプレートを指定することもできます。詳しくは、API 定義テンプレートおよび製品定義テンプレートの作成と使用を参照してください。コマンド | 説明 | サブコマンド |
---|---|---|
apic config | 構成変数のリスト表示と管理を行います。詳しくは、「構成変数の使用」を参照してください。 サブコマンドを指定しなかった場合、定義済み構成変数の値がリストされます。 |
|
apic create | プロジェクト成果物を作成します。 |
注: --template template-name オプションを使用することで、OpenAPI (Swagger 2.0) テンプレート・ファイルから API または製品を作成できます。
|
apic edit | API Designer をデフォルトの Web ブラウザーで開いて実行します。 | なし |
apic extensions | カタログ内の OpenAPI (Swagger 2.0) 拡張を管理します。 サブコマンドが指定されていない場合は、製品カタログ内の拡張をリストします。 Stability: prototype |
|
apic loopback | LoopBack プロジェクトとその成果物を作成します。 サブコマンドを指定しなかった場合、新しい LoopBack プロジェクトが作成されます。 これらのコマンドはすべて Stability: prototype です (ただし、loopback:app を除く)。 |
|
apic microgateway | Micro Gateway アプリケーションを作成します。 | なし |
apic validate | API 定義または製品定義の YAML ファイルを検証します。 | なし |
コマンド | 説明 | サブコマンド |
---|---|---|
apic logs | サーバー・ログを継続的にコンソールに表示します。 | なし apic:services logs の別名 |
apic props | ローカルで実行される LoopBack アプリケーションのサービス・プロパティーのリスト表示と管理を行います。 サブコマンドを指定しなかった場合、定義済みサービス・プロパティーの値がリストされます。 |
|
apic services | サービスのリスト表示と管理を行います。 サブコマンドを指定しなかった場合、現在実行されているすべてのサービスがリストされます。 |
|
apic start | このコマンドを LoopBack プロジェクトのディレクトリーで実行すると、LoopBack アプリケーションが起動します。それ以外のディレクトリーで実行すると、Micro Gateway が起動します。 | なし apic services:start の別名 |
apic stop | 指定されたサービスまたはすべてのサービスを停止します。 | なし apic services:stop の別名 |
apic explore | API Explore ツールを開きます。 プロジェクト・ディレクトリーに含まれているすべての API の操作、定義、およびドキュメンテーションが示されます。特定の API を指定するには、コマンドに API の名前を含めます。例えば、次のようにします。
|
オプション:
|
コマンド | 説明 | サブコマンド |
---|---|---|
apic apps | アプリケーションをリスト、管理、または公開します。 デフォルトのサブコマンドは list です。 |
|
apic apis | カタログまたはスペース内の API のリスト表示と管理を行います。Stability: prototype デフォルトのサブコマンドは list です。 |
|
apic catalogs | カタログのリスト表示と管理を行います。 |
|
apic devapps | コンシューマー・アプリケーションのリスト表示、およびコンシューマー・アプリケーションに関する情報の取得を行います。 デフォルトのサブコマンドは list です。 |
|
apic drafts | ドラフト内の API と製品のリスト表示と管理を行います。 デフォルトのサブコマンドは list です。 |
|
apic login | API Manager にログインします。 | なし。以下のように、必須のフラグを使用して、サーバーおよび資格情報を指定します。
サーバー名にポート番号を追加できます (ポート番号がデフォルト値の 443 ではない場合)。 |
apic logout | API Manager からログアウトします。 | なし。以下のように、必須のフラグを使用してサーバーを指定します。
サーバー名にポート番号を追加できます (ポート番号がデフォルト値の 443 ではない場合)。 |
apic members | 組織のメンバーをリストします。 Stability: prototype |
なし |
apic orgs:get | コンシューマー組織またはプロバイダー組織に関する情報を表示します。--type provider|consumer を使用して、プロバイダー組織またはコンシューマー組織のいずれかを指定します。 |
|
apic organizations apic orgs |
組織のリスト表示、および組織に関する情報の取得を行います。 デフォルトのサブコマンドは list です。 注: 以前のリリースに用意されていた organizations コマンドは非推奨になりました。orgs を使用してください。
|
|
apic policies | カタログ内のポリシーのリスト表示と管理を行います。 デフォルトのサブコマンドは list です。 |
|
apic publish | 製品とその参照先 API をカタログに公開します。 スペースがカタログに対して有効な場合、製品は、そのカタログ内のスペースに対してのみ公開できます。スペースへ公開するには、publish コマンドに --scope space オプションを含める必要があります。 |
なし これは、apic products:publish の別名です。 |
apic products | カタログ内の製品のリスト表示と管理を行います。 デフォルトのサブコマンドは list です。 |
|
apic spaces | カタログに含まれているスペースのリスト表示と管理を行います。 デフォルトのサブコマンドは list です。 |
|
apic subscriptions | 製品またはカタログのサブスクリプションのリスト表示と管理を行います。 デフォルトのサブコマンドは list です。 |
|