开发者学堂课程【阿里云 API 网关使用教程:如何生成和使用 SDK】学习笔记,与课程紧密联系,让用户快速学习知识。
课程地址:https://developer.aliyun.com/learning/course/406/detail/5240
如何生成和使用 SDK
内容简介
一、sdk 的文档目录设置
二、sdk 的使用
如果是 API 的开放者的就可以在开放 API 的目录下面找到 sdk 文档,自动生成了这个页面。
这里出现的 sdk 就是基于分组生成的,生成该某一个分组在线上所有 API 的 sdk。然后如果说是一个调用者,或者说自己要去通过 app 来认证的方式来测 API ,你可以在调用 API 的这个目录下找到一个应用管理的这个地方。然后我们点进去看一下应用管理。
以 test 为例,它显示出来它已被授权的所有 API ,点击 sdk 生成链接。
这里生成的 sdk 是这个应用所有已经被授权的这个 API 生成的 sdk ,
里面包含 API 相关文档、库文件、说明文档、SDK 等
一、sdk 文档目录的设置
目前 API 网关 JavaSDK 已在 github. 上开源
需要注意的一-点是,所有 API 和文档都会按照 Group 分组。
下文中所有出现的{{group}}都是指 API 所属 Group 的名称。
代码文件的层级结构如下:
●SDK 文件夹
。sdk JavaSDK 文件夹,包含每个 Group 的所有 API 的接口调用代码
■SyncApiClient {roup}java 包含对应 Group 所有 API 接口的同步调用方法
■AsyncApiClient {{group}.java 包含对应 Group 所有 API 接口的异步调用方法
●SyncDemo. <{roup}}java 同步调用示例代码
●AsyncDemo {{group}.java 异步调用示例代码
。doc
。ApiDocument ({groupl}.md对应 Group 的 API 接口文档
。lib
■sdk-core-java-1.0.2.jar sdk 的core 包, 为本 sdk 的依赖包
■sdk-core-java-1.0.2 sources.jar 上述依赖包的源码
。Readme.md 本 SDK 使用指南
。LICENSE 版权许可
二、sdk的使用
2.1环境准备
1.阿里云 API 网关 Java SDK 适用于 JDK 1.6 及以上版本
2.您需要准备-对授权密钥供 SDK 生成鉴权和签名信息,即 AppKey 和 AppSecret
重要提示: AppKey 和 AppSecret 是网关认证用户请求的密钥,这两个配置如果保存在客户端,请妥善加密。
3. 在 pom.xml 中添加如下依赖
把 pom 引入事先准备好的文件里
2.2引入 SDK 的 API 接口调用类、
1.把 sdk 文件夹中 AsyncApiClient *. java和SyncApiClient *. java文件复制到您的项目文件夹中;
2.修正这些类文件的 package;
2.3创建 ApiCllent
要提交请求至阿里云 API 网关,您首选要创建一个 ApiCLient 对象。您可以参考(A)SyncDemo. *。java 中的示例代码,使用 newBuilder()获得一个ApiCLientBuilder 对象来构建您的 ApiCLient :
我们对这个 API client 进行了初始化,就是这个 test client ,然后在正式调用的时候,需要把里面的 key 和 secret 换成自己 app 的对应的 key 和 secret。
接下来我们就可以发起这个调用了,在 SDK 中会把每一个 API 都封装成一个方法。
用这个 putbody 简单做一些演示,在数组地方输入一些参数,然后我们发起调用进行运行。