API ConnectのCLI
API Connectでは、Developers Toolkitというコマンド・ライン・ツール(以下CLI)を提供しています。このCLIを使うことで、API Connectの管理、APIの開発・管理が実現できます。詳しくはマニュアルを参照ください。
環境
API Connectは、AWSで提供されている30日間無料のトライアル環境を利用しています。トライアル環境の申込はこちらです。
Developers Toolkit(CLI)のダウンロード
Developers Toolkit(CLI)は、トライアル環境のホーム画面からダウンロードすることが可能です。画面真ん中の右側の"Tools for Download"からダウンロードできます。
今回は、CLIのみと資格情報をダウンロードし、ステップに従って操作します。
ダウンロードしたCLIを解凍し、コマンド実行できるようにします。セットアップ方法はこちらに記載があります。
% apic client-creds:set credentials.json
過去にCLIコマンドを使ったことがある場合は、credentialsを削除して、上記を実行します。
% apic client-creds:clear
クライアント資格情報を削除しました。
API ManagerへCLIからログイン
CLIからAPI Managerにログインしますが、この手順ではAPIキーを作成してAPIキーでログインします。APIキーは、API Managerの画面で作成することができます。
API Managerのホーム画面を開き、URLの後ろに/apikeysと入力すると、"マイAPIキー"の画面が表示されます。
"追加"をクリックして、APIキーを作成します。APIキーの作成についてはこちらに記載があります。必要な項目を入力するとAPIキーが作成されます。
続いて、作成したAPIキーでAPI Managerにログインします。コンテキスト?以降は対話式でのやり取りになります。
% apic login --server https://api-manager.us-east-a.apiconnect.automation.ibm.com/ --sso
コンテキスト? provider
認証プロセスを開始するには、URL https://api-manager.us-east-a.apiconnect.automation.ibm.com/manager/auth/manager/sign-in/?from=TOOLKIT をブラウザーにコピーして貼り付けてください。
Do you want to open the url in default browser? [y/n]: y
API キー? xxxxxxxxxxxxxxxxxx
api-manager.us-east-a.apiconnect.automation.ibm.com に正常にログインしました
これでAPI Managerにログインができ、CLI操作が可能になります。
CLI操作を実施する
CLI操作を実施するには、サーバー、プロバイダー組織、カタログなどの名前が必要になります。また、UIで大文字になっていても、CLIでは小文字で与える必要があります。
コマンド例: カタログのリスト取得
apic catalogs:list --server https://api-manager.us-east-a.apiconnect.automation.ibm.com/ --org <プロバイダー組織>
prod https://api-manager.us-east-a.apiconnect.automation.ibm.com/api/catalogs/xxxxxxxxxxxxxxx/xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
sandbox https://api-manager.us-east-a.apiconnect.automation.ibm.com/api/catalogs/xxxxxxxxxxxxxxxxx/xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
コマンド例: カタログ prod に公開されているAPI branchesを取得する
apic apis:list --scope catalog branches --server https://api-manager.us-east-a.apiconnect.automation.ibm.com/ --org <プロバイダー組織> --catalog prod
branches:1.0.0 [state: online] https://api-manager.us-east-a.apiconnect.automation.ibm.com/api/catalogs/xxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxx/apis/xxxxxxxxxx
APIをオフラインにする
上記で取得したAPIは、[state: online]になっています。webUIでもオンラインであることが確認できます。
CLIでオフラインにします。その際に設定変更するための以下のようなYamlファイルが必要になります。
state: offline
こちらのファイルをapic apis:updateの引数に渡します。
apic apis:update --scope catalog --server https://api-manager.us-east-a.apiconnect.automation.ibm.com/ --org <プロバイダー組織> --catalog prod branches:1.0.0 offline.yaml
branches:1.0.0 [state: offline] https://api-manager.us-east-a.apiconnect.automation.ibm.com/api/catalogs/fabb6de4-36ed-40e9-a76a-59554a0ca719/77f27ad1-f9bd-45d1-8c80-b74e1c20a32d/apis/5b6c92ca-5f95-4fcb-b4ef-67252055d073
これでofflineに設定することが可能です。webUIでもオフラインに変わっていることが確認できます。
まとめ
API Connect のトライアル環境で、Developer Toolkit (CLI)のダウンロードから実行まで行いました。様々な使い方ができそうです。
さらに詳しい情報をお探しの方へ
IBMの最新情報、イベント情報、さらに役立つ資料は、以下のIBM Communityでも発信・格納されています。
最新のトレンドや有益な情報をチェックするために、ぜひご覧ください！
- WebSphere: IBM Community - WebSphere
WebSphere関連の最新情報やディスカッション、イベント情報、技術資料を公開中！
- ELM (Engineering Lifecycle Management): IBM Community - ELM
ELMに関する最新のイベント情報、ナレッジ共有、便利なドキュメントをチェック！
- Integration: IBM Community - Integration
Integrationに関する最新のイベント情報、ナレッジ共有、便利なドキュメントをチェック！