本文主要引導用戶如何通過調用API網關自動生成的SDK,來在業務系統中調用發布好的API。
概述
在控制臺自動生成的SDK內置了簽名實現,可以免去繁瑣的簽名計算,若需要自行實現簽名認證您可以參考客戶端簽名說明文檔
調用API的前期步驟可參考創建后端服務為HTTP的API ,支持SDK調用的API需滿足:
API的安全認證方式為“阿里云APP”。
API與APP建立授權關系。
API已經發布到線上。
1. 下載SDK
控制臺提供兩種SDK的下載方式,如下:
1.1 在調用API
的已授權API的SDK
中下載應用APP的SDK,此SDK是基于APP生成的。目前支持自動生成的SDK語言包括Objective-C 、Android 、Java。其他語言調用示例在頁面下方。
1.2 在開放API
的SDK/文檔自動生成
中下載API分組的SDK。此SDK是基于分組生成的。目前支持自動生成的SDK語言包括Objective-C 、Android 、Java、GOlang、TypeScript。
2. 使用SDK調用API
通過控制臺下載的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調試自助排錯文檔來排查。