:OpenAPI Explorer とは

OpenAPI Explorer

OpenAPI Explorer は OpenAPI Portal とも呼ばれます。OpenAPI Explorer は、API 操作のためのインテリジェントな検索、ドキュメント、オンラインデバッグ、SDK の取得、サンプルコード、呼び出しエラー診断、呼び出し統計などの機能を統合しています。OpenAPI Explorer では、Alibaba Cloud サービスの API 操作を呼び出し、API リクエストと応答を表示できます。さらに、OpenAPI Explorer は対応する SDK サンプルコードを自動的に生成し、API 操作の利用を容易にします。

機能の説明

OpenAPI Explorer URL： https://next.api.alibabacloud.com

OpenAPI Explorer を使用する前に、OpenAPI Explorer にログインする必要があります。システムは、OpenAPI Explorer へのログインに使用したアカウントに基づいて AccessKey ペアを自動的に取得し、API 操作を呼び出します。デバッグページで AccessKey ペアを指定する必要はありません。これにより、OpenAPI Explorer でのサービスのデバッグがより便利になります。

OpenAPI Explorer は、以下の特徴を提供します：

• API 操作のクエリ

  OpenAPI Explorer には、さまざまな Alibaba Cloud サービスの API 操作が含まれています。OpenAPI Explorer で API 操作を迅速にクエリできます。

• API 操作の呼び出し

  コーディングなしで、呼び出しページでリクエストパラメーターを設定することで API 操作を呼び出すことができます。

• リクエストの表示

  OpenAPI Explorer は、指定されたリクエストパラメーターに従ってリクエスト URL を自動的に生成し、Web ページに視覚的に表示します。

• 応答の表示

  OpenAPI Explorer は、リクエストの応答として構造化データを返します。

• SDK サンプルコードの生成

  OpenAPI Explorer は、指定されたリクエストパラメーターに基づいて、複数のプログラミング言語で SDK サンプルコードを自動的に生成します。

• CLI を使用した API 操作の呼び出し

  Web ベースの CLI ツールを使用して、OpenAPI Explorer で API 操作を呼び出すことができます。これは、Linux で API 操作を呼び出す方法をシミュレートします。

利用シーン

API 操作のドキュメントの表示

OpenAPI Explorer は、各 API 操作の完全なドキュメントを提供します。これには、注意事項、速度制限情報、権限付与情報、リクエストパラメーター、レスポンスパラメーター、応答の説明、応答例、エラーコード、変更履歴が含まれます。API 操作のドキュメントを読むことで、その API 操作がビジネス要件を満たしているかどうかを判断できます。

デバッグ操作の実行

API 操作を使用して二次開発を行う前に、API 操作のリクエストメソッド、リクエストパラメーター、および応答を検証できます。OpenAPI Explorer は、Web ベースのデバッグと CLI デバッグのメソッドを提供しており、API リクエストの応答を視覚的に表示できます。API リクエストが失敗した場合、OpenAPI Explorer のプロンプトに従ってリクエストのトラブルシューティングを行うことができます。これにより、API 操作の特徴と注意事項を迅速に学習できます。

CLI デバッグの実行

クラウドリソースを管理するためのシェルスクリプトを書きたいが、コマンドの書き方がわからない場合は、OpenAPI Explorer のデバッグページに移動し、[CLI Example] タブをクリックしてコマンドを表示できます。

Alibaba Cloud SDK の統合

OpenAPI Explorer を使用すると、Alibaba Cloud SDK を統合して API 操作を呼び出すことができます。クラウドサービスのホームページの [Supported Languages] セクションには、そのサービス SDK でサポートされているすべてのプログラミング言語がリストされています。ビジネス要件に基づいて、プログラミング言語と統合メソッドを選択し、SDK をプロジェクトに統合できます。

Alibaba Cloud SDK を使用して開発を実装したい場合、開発を支援するためのサンプルコードが必要になることがあります。OpenAPI Explorer は、Java、PHP、Python、Node.js などの複数のプログラミング言語で SDK サンプルコードを自動的に生成し、開発プロセスを支援します。各プログラミング言語の SDK サンプルコードは [SDK Sample Code] タブで利用でき、SDK を迅速に統合するのに役立ちます。

ROS CDK の統合

Resource Orchestration Service (ROS) は、リソースの定義、リソースの作成と設定、および自動化されたデプロイメントと O&M (運用保守) を支援する Cloud Development Toolkit (CDK) を提供します。OpenAPI Explorer では、CDK の統合とデバッグが可能で、サンプルコードも提供されています。