快速开始
移动网关工作流
(1)客户业务服务器需要提供出具体的访问地址 URL。
(2)客户相关开发人员需要在 TMF 网关后台创建一个 API,将上面的 URL 配置在该 API 的后端服务 URL 项。
(3)选择合理的参数配置(可选),并确定生成 API。
(4)客户端会将请求数据发送到网关,网关解析到数据后会根据该 URL 配置项中的 HTTP/RPC 将数据转发到对应的业务服务器,然后业务服务器处理完成后将数据返回给网关,网关再将数据返回给客户端。
使用流程
创建并配置API
创建API组
具体创建流程请参见创建API组。
创建API
具体创建流程请参见创建API。
获取API标识
客户端发送网络请求时会使用到 API标识,cmdId 和 apiName 都是 API 的唯一标识, apiName 的优点是含义更清晰,发送请求时cmdId和apiName任选其一即可。
进入API管理页面即可看到API标识。
设置API参数及校验规则
通过网关管理后台可以给 API 定义对应的参数,如下图所示:
(1) 如果开启了“必选”开关,那么客户端发送到网关的请求会对该参数进行检查。
(2) 参数位置分为 query、body、header,管理后台创建API时需要选择参数的位置;客户端发起请求时需要将对应的参数填充到 SharkHttpEntity 结构体中。
header | HTTP 请求的 header |
---|---|
query | get 请求中的 query 参数 |
body | post 请求的 body 参数 |
创建虚拟API辅助接入测试
正常情况下应该根据后台开发完成的 URL 创建 API,但为了后续 SDK 接入测试,我们可以开启API Mock,模拟响应数据返回,具体操作流程如下:
- 在控制台移动网关网关配置页面开启全局API Mock开关。
- 创建一个虚拟的 API 组,下面的服务地址随意填写,因为是虚拟 API,如下图所示:
- 创建虚拟API
- 在高级配置中开启API Mock开关并设置响应体
- 返回API列表,点击测试按钮测试您的API Mock响应。
测试结果如下表示虚拟 API 创建成功。