开发者社区> 问答> 正文

API 网关如何上架云市场?


完成前后端配置之后,就完成了 API 定义的配置。接下来还需要做调试、测试、线上发布。然后就可以上架云市场了。

步骤 1:调试


在 API 网关控制台,进入 API 的管理,有个调试页面。在该页面可以设定入参来简单调试,调试默认调用的是测试环境的 API,所以需要把 API 发布到测试环境。如下图:

  1. 页面可以支持 [backcolor=transparent]Mock 或者非 [backcolor=transparent]Mock 两种调试。
  2. 选择 [backcolor=transparent]Mock,需要写定返回结果,[backcolor=transparent]Mock 下调试不会真的去调用后端,但是会把访问后端之前的参数、[backcolor=transparent]Path 寻址都校验掉。
  3. 不选择 [backcolor=transparent]Mock 则会真实调用后端服务,右侧会返回真实的请求结果,这个结果可以是 API 网关返回的也可以是您后端返回的,看具体情况。


步骤 2:测试


这里区别于调试的就是需要真实的模拟 API 使用者的场景来调用测试环境的 API。测试环境的 API 可以通过分组的二级域名进行访问,此时可以尚未绑定独立域名。
API 需要发布到测试环境,需要创建 APP 并操作授权后,才能真实模拟 API 调用。
发布 API 到测试环境,发布成功后在 API 列表环境的测试后面显示 [backcolor=transparent]运行中。

[backcolor=transparent]创建 APP。

[backcolor=transparent]查看应用 ID,应用 ID 后面要用于搜索 APP。

[backcolor=transparent]授权使该 APP 可以调用该 API,授权要注意区分环境。

[backcolor=transparent]更多说明:
  1. 至此,您已经能够使用您创建的 APP 的 [backcolor=transparent]Key 和 [backcolor=transparent]Secret 模拟第三方客户调用了。[backcolor=transparent]Key 和 [backcolor=transparent]Secret 在控制台应用详情查看。具体调用说明请参见 快速入门(调用 API)
  2. APP 是 API 使用者调用 API 的身份,每一个 API 的使用者都需要申请 APP。具体调用说明请参见 快速入门(调用 API)
  3. APP 和 API 之间的鉴权关系通过授权来实现,就是哪个 APP 有调用哪个 API 的权限。授权的完成可以通过 API 开放者主动授权和数据市场完成购买两种方式。具体请参见 快速入门(调用 API)


步骤 3:线上发布后上架数据市场

  1. 您需要准备一个独立域名。该独立域名不能与您后端服务地址相同,但是可以为现有域名的二级、三级甚至更多级的域名。
  2. 该域名需要解析到分组的二级域名上。比如您要把某一组 API 上架数据市场,那么就要将独立域名 [backcolor=transparent]CNAME 解析到该分组的二级域名上。
  3. 该域名需要在阿里云 备案,或者原备案不在阿里云但是完成在阿里云的 备案接入
  4. 在 API 网关控制台,把准备好的域名绑定到分组上。
  5. 操作 API 发布到线上环境,然后就可以在数据市场走上架流程了。请参见 数据市场上架引导


步骤4: 辅助 CheckList

  1. 调试、测试调不通,检查服务地址和 [backcolor=transparent]Path 配置是否正确。
  2. 返回结果不对,API 网关支持您把后端的 a 映射成前端的 b,检查映射是否正确。
  3. 调不通,检查绑定的独立域名是否在阿里云备案,或者是否在阿里云接入备案。
  4. 调不通,检查绑定的独立域名是否正确 [backcolor=transparent]CNAME 解析到相应的二级域名上。
  5. 如果 [backcolor=transparent]Invalid Url 报错,检查在调试、测试 API 时, API 是否已经发布到测试环境(环境后显示“运行中”才是发布完成)。
  6. 如果 [backcolor=transparent]Invalid Url 报错,检查上架数据市场时,API 是否已经发布到线上(环境后显示“运行中”才是发布完成)。
  7. 在重新更改了定义后,调用发现没生效时,检查是否重新操作了发布。
  8. 上架数据市场的 API 不能选择 [backcolor=transparent]无认证,不能选择 [backcolor=transparent]私有。

展开
收起
轩墨 2017-10-26 11:30:06 2229 0
0 条回答
写回答
取消 提交回答
问答排行榜
最热
最新

相关电子书

更多
CUDA MATH API 立即下载
API PLAYBOOK 立即下载
传统企业的“+互联网”-API服务在京东方的实践 立即下载