全部产品

步骤 4:发布 API

更新时间:2017-07-05 14:44:52

完成 API 创建后,需要进行调试、测试和正式上线 API。

操作步骤:

1.调试

您要把 API 发布到测试环境,然后在 API 网关控制台的调试页面上调试 API。

调试时,会跳过 APP 鉴权签名校验 环节,只是调试 API 的请求链路是否正确。

如果您勾选了 Mock,就是把返回结果定义为一个常量,然后调试时不会真的去请求后端服务,而会直接返回常量结果。这种 Mock 调试模式,不要求后端服务完备。

如果未勾选 Mock,则网关会真实地请求后端服务。返回信息里可能有网关的 X-Ca 开头的返回信息,也会有底层服务真实返回的信息。

2.测试

为了模拟真实的用户请求,您可以自己创建一个 APP,操作您的 API 给这个 APP 授权。

然后按照真实的请求场景,写代码或者基于网关提供的 SDK 样例 请求 API。

您可以将 API 发布到测试或者线上环境,在绑定独立域名之前,可以直接访问二级域名来进行测试调用。请求时注意指定环境,若不指定则默认为访问线上。参见 API 调用示例

调用API的方法,请您查看 使用手册(调用 API)

3.发布

完成测试后,您就可以把 API 开放出去了。

要上架到 API 市场则必须将 API 发布到线上,且 API 的类型应为公开。

对外开放的 API,应在所属分组上绑定独立域名,直接访问二级域名有流控限制为1000次/天。

API 网关支持对测试/线上的 API 做版本管理,您可以发布 API、下线 API 还可以切换版本,切换版本是实时生效。