すべてのプロダクト
Search
ドキュメントセンター

:OpenAPI Explorer の概要

最終更新日:Feb 27, 2024

OpenAPI Explorer とは、ウェブベースのビジュアル API 呼び出しツールです。 Alibaba Cloud 製品の API の呼び出しが可能で、 OpenAPI Explorer でのリクエスト構造とレスポンスが参照できます。 加えて、 OpenAPI Explorer は API リクエストに従って自動的に SDK サンプルを作成し、 Alibaba Cloud SDK を用いたアプリケーションの構築を支援します。

OpenAPI Explorer の URL は 『https://next.api.alibabacloud.com』です。

説明

OpenAPI Explorer は無料の API 呼び出しツールです。 しかし、 ECS インスタンスなどのクラウドリソースを作成する目的で API を使用した場合には、料金が発生する可能性があります。 詳細は、各クラウド製品のドキュメントをご参照ください。

OpenAPI Explorer は次の機能を提供します。

  • API の検索

    OpenAPI Explorer には、ほぼ全製品の API が含まれています。 OpenAPI Explorer は、使用したい API を迅速に検索します。

  • API の呼び出し

    ウェブページに要求値をゼロコードで入力すると、API を呼び出せます。

  • リクエスト URL の表示

    リクエストパラメーターに従って、 OpenAPI Explorer は自動的にリクエスト URLを生成します。

  • レスポンスの表示

    リクエストに対するレスポンスは、自動的に JSON フォーマットに表示されます。

  • SDK サンプルの生成

    OpenAPI Explorer は、 API リクエストに従って自動的に SDK サンプルを生成します。

  • CLI 呼び出しのサポート

    ウェブベースの CLI ツールである Cloud Shell を用いて、OpenAPI Explorer でクラウドリソースの管理が可能です。

シナリオ

OpenAPI Explorer は、 Alibaba Cloud ベースのアプリケーションを開発するために、 Alibaba Cloud 製品の API を容易に見つけ出し使用することに特化しています。 OpenAPI Explorer は、どの API が Alibaba Cloud から提供されたか特定することもできます。詳細は、 API 定義をご参照ください。 OpenAPI Explorer は API デバッグやトラブルシューティングなどのシナリオに適用できます。

  • Alibaba Cloud API の呼び出し

    Alibaba Cloud API をベースにしたアプリケーション開発を始める前に、 API リクエストとレスポンスの確認が必要な場合があります。 OpenAPI Explorer はウェブページベースのオンラインデバッグとCLI デバッグメソッドを提供しています。これにより、可視化された API コールの結果を確認できるようになります。 さらに、API の呼び出しが失敗した場合、 OpenAPI Explorer に表示されたエラーメッセージに従って、リクエストの問題を解決できます。

  • SDK サンプルの表示

    Alibaba Cloud SDK を使ったアプリケーション開発の際には、開発を支援するいくつかのコードサンプルが必要になるケースが多々あります。 OpenAPI Explorer は API リクエストに従って、 Java 、 PHP 、 Python 、 Node.JS などのプログラム言語の SDK サンプルを自動生成し、開発プロセスをわかりやすく説明します。