API Gateway:SDK を使用した API の呼び出し

事前準備

自動生成された SDK には署名実装が組み込まれているため、署名計算を自分で処理する必要はありません。署名認証を手動で実装する場合は、「クライアント側署名の手順」をご参照ください。

続行する前に、「HTTP バックエンドサービスを使用した API の作成」の手順を完了してください。SDK で API を呼び出すには、API が以下のすべての要件を満たしている必要があります。

• セキュリティ認証方法が Alibaba Cloud App に設定されている。

• API を呼び出すためのアプリケーション認可が完了している。

• API がオンライン環境に公開されている。

1. SDK のダウンロード

コンソールでは、アプリケーション単位の SDK とグループ単位の SDK のいずれかをダウンロードできる、2 つのダウンロードパスが用意されています。

1. アプリケーション別: 左側のナビゲーションペインで、[API コール] > [SDK] を選択し、[承認済み API] タブをクリックします。[承認済み API の自動生成 SDK/ドキュメント] セクションで、お使いのアプリケーションの SDK をダウンロードします。サポートされている自動生成言語: Objective-C、Android、Java。他の言語のコール例は、ページの下部に表示されます。

2. API グループ別: 左側のナビゲーションペインで、[API コール] > [SDK] を選択し、次に [グループ API] をクリックします。[自動生成された SDK/ドキュメント] セクションで、API グループの SDK をダウンロードします。サポートされている自動生成言語: Objective-C、Android、Java、Go、TypeScript。

2. SDK を使用した API の呼び出し

解凍した SDK パッケージには、以下のディレクトリ構造が含まれています。

• sdk フォルダー：リージョンとグループごとに整理された Java SDK ソースファイル。

  * sdk/{{regionId}}：各グループのすべての API 操作用の Java SDK フォルダー。

  * HttpApiClient{{group}}.java：HTTP チャネルを使用する API 操作のクライアントメソッド。

  * HttpsApiClient{{group}}.java：HTTPS チャネルを使用する API 操作のクライアントメソッド。

  * WebSocketApiClient{{group}}.java：WebSocket チャネルを使用する API 操作のクライアントメソッド。

  * Demo{{group}}.java：グループ内のすべての API 操作の実行可能な呼び出し例。

• doc/{{regionId}} フォルダー：API リファレンスドキュメント。

  * ApiDocument_{{group}}.md：対応するグループの API リファレンス。

• lib フォルダー：SDK コア依存関係。

  * sdk-core-java-1.1.5.jar：コア SDK パッケージ。必須。

  * sdk-core-java-1.1.5-sources.jar：コアパッケージのソースコード。

  * sdk-core-java-1.1.5-javadoc.jar：コアパッケージの Javadoc。

• Readme.md：統合手順を段階的に説明した SDK ユーザーガイド。

• LICENSE：著作権ライセンス。

Readme.md の手順に従って、SDK をアプリケーションに統合し、API 呼び出しを実行してください。

3. トラブルシューティング

呼び出しが失敗した場合は、レスポンスヘッダーからリクエスト ID を取得して問題を特定してください。診断手順については、「API デバッグとセルフサービストラブルシューティング」をご参照ください。