API网关 APIG-开放API流程

时间:2025-01-10 16:46:25

开放API流程

企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。

  1. 创建API分组

    每个API都归属到某一个API分组下,在创建API前应提前创建API分组。

  2. 添加API的SSL证书

    如果API分组中的API支持HTTPS请求协议,需要为独立 域名 添加SSL证书。反之,跳过此步骤。

  3. 配置API的调用域名

    在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。

    在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。系统自动分配的域名不能用于生产业务,且仅限应用程序调试使用。

  4. 创建API的负载通道(可选)

    如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。

  5. 创建API

    把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。

    API创建成功后,您可根据业务需求配置API策略管理API等。

  6. 调试APIG创建的API

    通过APIG提供的在线调试功能验证 API服务 是否正常可用。

  7. 配置API的发布环境和环境变量(可选)

    API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是系统默认的发布环境,如果使用RELEASE环境,可跳过配置发布环境步骤。

    如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个API,在不同环境中调用不同的后端服务。

  8. 发布APIG创建的API

    把API发布到环境中,API只有在发布到环境后,才支持被调用。

support.huaweicloud.com/usermanual-apig/apig_03_0127.html