更新时间:2025-10-16 GMT+08:00
分享

开放API流程

API提供者将成熟的业务能力(如服务、数据等)作为后端服务,在API网关中开放API,实现业务能力变现。

图1 开放API基本流程
  1. 创建API分组

    API分组相当于API的集合,API网关以分组为单位管理环境变量、访问域名以及网关响应等功能。详情请参考创建API分组

  2. 绑定域名

    为API分组绑定一个或多个独立域名(即自定义域名),API调用者通过访问独立域名来调用API。详情请参考绑定域名

  3. 创建API

    定义API前后端的请求路径、参数、请求相关协议等。详情请参考创建API

    API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。详情请参考导入API

  4. 调试API

    通过添加HTTP头部参数与body体参数,调试API接口,验证服务是否正常。详情请参考调试API

  5. 创建环境和环境变量(可选)

    API可以同时提供给不同的场景调用,如生产环境(RELEASE)及其他自定义环境。API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。详情请参考创建环境和环境变量

  6. 发布API

    将API发布到环境后,API才支持被调用。详情请参考发布API

  7. 创建流控策略(可选)

    限制单位时间内API的被调用次数,提供持续稳定的服务。详情请参考创建流控策略并绑定到API

相关文档