全部产品

使用SDK调用API

更新时间:2020-10-10 16:26:21

本文主要引导用户如何通过调用API网关自动生成的SDK,来在业务系统中调用发布好的API。

概述

在控制台自动生成的SDK内置了签名实现,可以免去繁琐的签名计算,若需要自行实现签名认证您可以参考客户端签名说明文档

调用API的前期步骤可参考创建后端服务为HTTP的API,支持SDK调用的API需满足:

  • API的安全认证方式为“阿里云APP”或“OpenID Connect & 阿里云APP”。

  • API与APP建立授权关系。

  • API已经发布到线上。

1. 下载SDK

控制台提供两种SDK的下载方式,如下:

1.1 调用API已授权API的SDK中下载应用APP的SDK,此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C 、Android 、Java。其他语言调用示例在页面下方。

下载SDK

1.2开放APISDK/文档自动生成中下载API分组的SDK。此SDK是基于分组生成的。目前支持自动生成的SDK语言包括Objective-C 、Android 、Java、GOlang、TypeScript。

SDK自动生成

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,然后根据自助排错文档来排查。

Requestid