全部產品
Search
文件中心

API Gateway:使用SDK調用API

更新時間:Mar 13, 2025

本文主要引導使用者如何通過調用API Gateway自動產生的SDK,來在業務系統中調用發布好的API。

概述

在控制台自動產生的SDK內建了簽名實現,可以免去繁瑣的簽名計算,若需要自行實現簽名認證您可以參考用戶端簽名說明文檔

調用API的前期步驟可參考建立後端服務為HTTP的API ,支援SDK調用的API需滿足:

  • API的安全認證方式為“阿里雲APP”。

  • API與APP建立授權關係。

  • API已經發布到線上。

1. 下載SDK

控制台提供兩種SDK的下載方式,如下:

  1. 在左側導覽列的API調用 > SDK中,選擇已授權API頁簽。在已經授權API的SDK/文檔自動產生中下載應用APP的SDK,此SDK是基於APP產生的。目前支援自動產生的SDK語言套件括Objective-C 、Android 、Java。其他語言調用樣本在頁面下方。

  2. 在左側導覽列的API調用 > SDK中,選擇分組API,在SDK/文檔自動產生中下載API分組的SDK。此SDK是基於分組產生的。目前支援自動產生的SDK語言套件括Objective-C 、Android 、Java、Golang、TypeScript。

2. 使用SDK調用API

通過控制台下載的SDK,下載解壓後的目錄結構如圖:

SDK目錄

  • SDK檔案夾。

    * sdk/{{regionId}}`JavaSDK檔案夾,包含每個Group的所有API的介面調用代碼`。

    * HttpApiClient{{group}}.java `包含對應Group所有HTTP通道的API方法`。

    * HttpsApiClient{{group}}.java`包含對應Group所有HTTPS通道API方法`。

    * WebSocketApiClient{{group}}.java `包含對應Group所有WebSocket通道的API方法`。

    * Demo{{group}}.java `包含對應Group所有API調用樣本`。

  • doc/{{regionId}}檔案夾。

    * ApiDocument_{{group}}.md`對應Group的API介面文檔`。

  • lib檔案夾。

    * sdk-core-java-1.1.5.jar `sdk的core包,為本SDK的依賴包`。

    * sdk-core-java-1.1.5-sources.jar`上述依賴包的源碼`。

    * sdk-core-java-1.1.5-javadoc.jar`core包的文檔`。

  • Readme.md`本SDK使用指南`。

  • LICENSE `著作權許可`。

其中Readme.md文檔為本SDK的使用指南,有詳細的步驟,請參考Readme.md文檔來實現SDK的調用。

重要

“AppKey”和“AppSecret”是網關認證使用者請求的密鑰,這兩個配置如果儲存在用戶端,請妥善加密。

3. 排錯

使用SDK調用API若出現報錯,您可以在請求的ResponseHeader中擷取RequestId,然後根據API調試及自助排錯文檔來排查。

Requestid