API Gateway 的 Android SDK

阅读数:11 2019 年 11 月 14 日 08:00

API Gateway 的Android SDK

1. 背景介绍

Amazon API Gateway 是一种完全托管的服务,可以帮助开发者轻松创建、发布、维护、监控和保护任意规模的 API。作为无服务器架构中的一个重要组成部分,已经有越来越多的用户熟悉并使用 Amazon API Gateway。为了让大家更轻松地调用生成的 API,Amazon API Gateway 还提供了生成客户端 SDK 的功能,目前支持的客户端语言包括 Java、JavaScript、iOS(Object-C)、iOS(Swift) 和 Android。

今天,我们通过一个具体的例子演示一下 Android SDK,帮助大家快速上手,更方便轻松地使用 Amazon API Gateway。

2. 配置部署 API

我们参考官方文档中的宠物店这个例子,配置一套代理 HTTP 接口的 API。我们简化接口定义,以便突出 Android SDK 的使用,只做 2 个接口:

/pets

方法: GET

参数:

type String 宠物类型

page int 页码

/pets/{id}

方法: GET

参数: 无

2.1 创建 Model

我们的 API 代理的后端接口还是这个宠物店的接口

http://petstore-demo-endpoint.execute-api.com/petstore/pets

我们先根据其返回结果创建相关的结果数据模型。

我们以 Oregon 区域为例,打开 Amazon API Gateway 管理控制台

https://us-west-2.console.aws.amazon.com/apigateway/home?region=us-west-2

点击 Create API

保持 New API 选中不变。

API name 填写 petstore。

Description 填写 A demo API for Android SDK.。点击 Create API 按钮。

这时左侧导航链接会显示成 APIs > petstore> Resources。点击导航链接中的 APIs > petstore> Models。这里已经显示有 2 个默认创建出来的 Model。我们点击 Create 按钮再来创建一个。

2.1.1 Pets: 宠物列表的 Model

Model name* 填写 Pets

Content type* 填写 application/json

Model description 填写 A list of pets。

我们使用 https://jsonschema.net/ 这个在线工具来生成 Model schema。

Root ID 填写 pets。

我们直接访问 http://petstore-demo-endpoint.execute-api.com/petstore/pets

[
{
"id": 1,
"type": "dog",
"price": 249.99
},
{
"id": 2,
"type": "cat",
"price": 124.99
},
{
"id": 3,
"type": "fish",
"price": 0.99
}
]

帖到 JSON 栏中,其它选项保持不变,点击 Generate Schema 按钮,结果生成在右侧的窗格中。

API Gateway 的Android SDK

复制出来,粘贴到 Model schema 格中即可。点击 Creat Model 按钮保存完成。

2.1.2 Pet: 宠物详情接口的 Model

点击 Create 按钮再来创建一个。

Model name* 填写 Pet。

Content type* 填写 application/json。

Model description 填写 A pet。

我们再使用 https://jsonschema.net/ 这个在线工具来生成 Model schema。

Root ID 填写 pet。

我们直接访问 http://petstore-demo-endpoint.execute-api.com/petstore/pets/1

把得到的返回结果

{
"id": 1,
"type":
"dog",
"price":249.99
}

帖到 JSON 栏中,其它选项保持不变,点击 Generate Schema 按钮,结果生成在右侧的窗格中。复制出来,粘贴到 Model schema 格中。点击 Creat Model 按钮保存完成。

2.2 配置 API

2.2.1 宠物列表接口

左侧导航链接点击 APIs > petstore> Resources。保持最顶层的 / 为选中状态时,点击 Actions 下拉菜单,选择 Create Resource。

Resource Name* 填写 pets

Resource Path 自动填写了 pets。然后点击 Create Resource 按钮。

这时刚刚创建的 /pets 应该是选中状态,再点击 Actions 下拉菜单,选择 Create Method,在当时出现的方法菜单里选择 GET,然后点后面的对号符确定。

然后在 /pets – GET – Setup 页,Integration type 选 HTTP。

Endpoint URL 填写 http://petstore-demo-endpoint.execute-api.com/petstore/pets。

其它保持默认,点击 Save 按钮。

创建成功后,点击 Method Request 链接,在 Method Request 配置页,点击 URL Query String Parameters 展开之。

点击 Add query string 增加一个参数 type ,点击 Add query string 增加第二个参数 page。其它项保持默认。

点击 Method Execution 链接返回,点击 Method Response 链接。在 Method Response 配置页,点击 200 左边的三角形,展开响应详情。在 Response Body for 200 下点击铅笔图标编辑之,把 Model 菜单下选择 Pets,然后点击对勾图标保存。

API Gateway 的Android SDK

点击 Method Execution 链接返回,点击 TEST 链接,我们来测试一下。Query Strings 下面 type 输入 dog,page 输入 1,然后点击 Test 按钮。右侧会显示出形如如下结果,表示这个 API 已经配置成功。

Request: /pets?type=dog&page=1

Status: 200

Latency: 271 ms

Response Body

[
{
"id": 1,
"type": "dog",
"price": 249.99
},
{
"id": 2,
"type": "dog",
"price": 124.99
},
{
"id": 3,
"type": "dog",
"price": 0.99
}
]

2.2.2 宠物详情接口

左侧导航链接点击 APIs > petstore> Resources。保持最顶层的 /pets 为选中状态时,点击 Actions 下拉菜单,选择 Create Resource。

Resource Name* 填写{petId}

Resource Path 自动填写了 –petid-,把它删掉,改成{petId}。然后点击 Create Resource 按钮。

这时刚刚创建的 /{petId}应该是选中状态,再点击 Actions 下拉菜单,选择 Create Method,在当时出现的方法菜单里选择 GET,然后点后面的对号符确定。

然后在 /pets/{petId} – GET – Setup 页,Integration type 选 HTTP。

Endpoint URL 填写 http://petstore-demo-endpoint.execute-api.com/petstore/pets/{petId}。

其它保持默认,点击 Save 按钮。

创建成功后,点击 Method Request 链接,在 Method Request 配置页,点击 Request Paths 展开之,确认这里已经有一条 petId 了。如果没有,请返回 Create Resource 步骤检查。

点击 Method Execution 链接返回,点击 Method Response 链接。在 Method Response 配置页,点击 200 左边的三角形,展开响应详情。在 Response Body for 200 下点击铅笔图标编辑之,把 Model 菜单下选择 Pet,然后点击对勾图标保存。

点击 Method Execution 链接返回,点击 TEST 链接,我们来测试一下。Query Strings 下面{petId}输入 1,然后点击 Test 按钮。右侧会显示出如下结果,表示这个 API 已经配置成功。

Request: /pets/1

Status: 200

Latency: 357 ms

Response
Body

{
"id": 1,
"type": "dog",
"price": 249.99
`}

复制代码
**2.3.1 部署 API**
左侧导航链接点击 APIs > petstore> Resources,Action 菜单点击 Deploy API,在弹出层里
Deployment stage 菜单下拉选 [New Stage]。
Stage name* 填写 test。
Stage description 填写 test stage。
Deployment description 填写 first deploy。
点击 Deploy 按钮。部署成功后会跳转到 test Stage Editor。可以看到
Invoke URL: 形如 https://abcde12345.execute-api.us-west-2.amazonaws.com/test
我们把这个 URL 后面接上前述配置过的 API 路径,再来测试一下。因为我们配置的没有 AUTH 难,所以可以简单的使用游览器直接访问,比如
https://abcde12345.execute-api.us-west-2.amazonaws.com/test/pets
可以得到宠物列表的 JSON 结果就表示部署成功了。同理可以再测试一下
https://abcde12345.execute-api.us-west-2.amazonaws.com/test/pets/1
**2.3.1 生成 SDK**
在 test Stage Editor 页点击 SDK Generation 选项卡,Platform* 选 Android。下面展开的内容,都和我们即将开发的 Android App 包名有关,我们先定好包名为 com.example.petstore。相应的这里几项这样填写:
Group ID 填写 com.example
Invoker package 填写完整包名 com.example.petstore
Artifact ID 填写 petstore
Artifact version 填写自己编排的版本号,比如 1.0.0
然后点击 Generate SDK 按钮,弹出下载文件对话框,保存到本机即可。
这是一个 ZIP 压缩包,解压可以得到以下目录和文件。
│ build.gradle
│ LICENSE.txt
│ NOTICE.txt
│ pom.xml
│ README.md
└─src
└─main
└─java
└─com
└─example
└─petstore
│ PetstoreClient.java
└─model
Pet.java
Pets.java
PetsItem.java
先放在这备用。下面我们用 Android Studio 开始做 App 项目。
### 3. Android 开发整合 SDK
#### 3.1 创建一个新的 Android 项目
我们打开 Android Studio,新建一个项目,Application name 填写 Petstore,Company domain 填写 example.com,从而 Package name 成为 com.example.petstore,和我们前面生成 SDK 时使用的包名保持一致。
!
然后一路点击 Next ,使用默认配置(Empty Activity, Activity Name 是 MainActivity,Layout Name 是 activity_main)创建一个项目。
#### 3.2 整合 API Gateway 生成的 Android SDK
使用 API Gateway 生成的 SDK 其实有官方文档:
http://docs.aws.amazon.com/zh_cn/apigateway/latest/developerguide/how-to-generate-sdk-android.html
但是我们今天用更简便的方法,直接用 build.gradle 管理包,不需要按官方文档那样安装 Maven 再编译等。
项目创建起来后,我们在 Project 面板启用 Project 视图。
打开 app/build.gradle,在 dependencies 段添加以下几行,其实就是 AWS SDK 的核心包,API Gateway 的包以及用于解析 JSON 的 gson 包。
`compile 'com.amazonaws:aws-android-sdk-core:2.4.+'`
`compile "com.amazonaws:aws-android-sdk-apigateway-core:2.4+"`
`compile 'com.google.code.gson:gson:2.8.0'`
然后按提示点击 Sync now 同步项目。这时会下载上述 3 个依赖库,视网络状态可能需要一些时间。我们可以不用等待,继续后面的配置。
添加访问互联网权限, 打开 /app/src/main/AndroidManifest.xml,在 <application 节点前面加上一行:
`<uses-permission android:name="android.permission.INTERNET" />`
我们打开之前下载的 SDK 压缩包解压的目录 src/main/java/com/example/petstore,把下面的文件和目录
│ PetstoreClient.java
└─model
Pet.java
Pets.java
PetsItem.java
复制到 Android 项目中 com.example.petstore 下面。完成的样子如下图所示:
!
#### 3.3 编写代码用 SDK 实现调用 API
我们使用 Cognito 进行验证,所以需要先创建一个 Cognito 的 Federated identity pool,有关方法请参阅相关文档,这里不再赘述。
http://docs.aws.amazon.com/zh_cn/cognito/latest/developerguide/identity-pools.html
在 Android Studio 里打开 MainActivity.java。先定义 2 个常量
!
然后我们定义一个 testPet() 方法。
!
!
最后在 onCreate() 方法里加上如下代码,新开线程做 HTTP 请求,就可以了。
!
到这里例子已经完成,我们运行一个 App,顺利地话可以看到如下的日志输出,我们已经可以顺利得到 API 接口的响应结果了。
!
这是在模拟器上运行的弹出层效果的截图。
!
例子的源码在下面 git 库的 Petstore 目录,供大家参考。
https://github.com/xfsnow/android
使用时请记得把 MainActivity.java 里的 COGNITO_POOL_ID 换成你自己真实的值,以及 new CognitoCachingCredentialsProvider 时要使用你的 COGNITO_POOL_ID 所在的 region 值。
### 4. 小结
Amazon API Gateway 生成的客户端 SDK 主要功能包括以下几点:
* 根据我们为各个接口定义的 Model 批量创建好相应的 Model 类。
* 通过 AWS 核心 SDK 实现 HTTP 请求的验证。
* 封装 HTTP 请求和响应。
* 把响应结果通过 Gson 库转换成方便 Android Java 使用的 Model 类。
这个简单的例子也体现出生成的客户端 SDK 便利了客户端应用程序的开发。
** 作者介绍:**
!
薛峰,亚马逊 AWS 解决方案架构师,AWS 的云计算方案架构的咨询和设计,同时致力于 AWS 云服务在国内和全球的应用和推广,在大规模并发应用架构、移动应用以及无服务器架构等方面有丰富的实践经验。在加入 AWS 之前曾长期从事互联网应用开发,先后在新浪、唯品会等公司担任架构师、技术总监等职位。对跨平台多终端的互联网应用架构和方案有深入的研究。
** 本文转载自 AWS 技术博客。**
** 原文链接:**
https://amazonaws-china.com/cn/blogs/china/api-gateway-android-sd

欲了解 AWS 的更多信息,请访问【AWS 技术专区】

评论

发布