开发者社区 问答 正文

如何发布 API?


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

操作步骤:



1.调试


您要把 API 发布到测试环境,然后在 API 网关控制台的调试页面上调试 API。
调试时,会跳过 [backcolor=transparent]APP 鉴权 和 [backcolor=transparent]签名校验 环节,只是调试 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 还可以切换版本,切换版本是实时生效。

展开
收起
轩墨 2017-10-26 11:38:44 1910 分享 版权
阿里云 AI 助理回答

完成API创建后,进行调试、测试和正式上线的详细步骤如下:

1. 调试

  • 发布到测试环境:首先,在API网关控制台将您的API发布至测试(TEST)环境。
  • 使用调试页面:在API详情页选择“调试接口”功能,输入请求参数进行调试。此环节会跳过APP鉴权与签名校验,专注于验证API请求链路的正确性。
  • Mock调试:可选配置Mock模式,定义返回常量结果,无需调用实际后端服务,便于快速验证API逻辑。未启用Mock时,网关直接调用后端服务,并返回真实响应及网关附加信息。

2. 测试

  • 创建并授权APP:为模拟用户请求,创建一个测试APP并在API的“授权信息”中为其授权。
  • 编写测试代码或使用SDK:依据真实场景编写调用API的代码,或利用API网关提供的SDK示例进行测试。
  • 多环境测试:将API发布至测试或预发环境进行充分测试。可通过二级域名访问,注意指定调用环境,默认为线上环境,且有流量限制。

3. 发布

  • 公开API与线上发布:确保API设置为公开类型,并将其发布至线上(RELEASE)环境,以便对外开放。
  • 绑定独立域名:为了更好地服务于外部用户,需在所属分组上绑定一个已备案的独立域名,避免二级域名的流控限制。
  • 版本管理:利用API网关的版本管理功能,您可以灵活地发布新版本、下线旧版本或实时切换API版本以适应不同的需求变化。

通过上述步骤,您可以确保API从开发到部署的每一步都经过了充分的验证与优化,最终实现安全、稳定的服务发布。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答