更新时间:2024-12-19 GMT+08:00
分享

构建API信息

前提条件

  • API网关类商品上架后,由华为云的AIPG网关进行鉴权和计费,鉴权通过后将相关参数转发到商家的后端服务进行处理,无论业务侧处理结果成功或失败,转发成功则计费一次调用。
  • 发布API类商品前,商家需要先创建API分组,目前华为云云商店支持华北-北京四华南-广州华东-上海一的API商品发布到云商店,请确保创建的API分组所在区域为以上区域。
  • 使用共享版网关会产生相关的费用

  • 当前只支持APIG共享版网关对接云商店进行售卖,由于APIG共享版网关不再新增用户,控制台无直接访问入口,请点击下方详情进行访问:

Region

访问链接

华北-北京四

点击访问

华南-广州

点击访问

华东-上海一

点击访问

操作步骤

  1. 创建API分组。(若目标API分组已创建完成,此步骤可忽略。)

    1. 左侧导航选择“开放API > API分组”,单击“创建分组”。

    2. 输入分组名称、描述,单击确定。

    信息项

    描述

    分组名称

    API分组名称,用于将API接口进行分组管理。

    描述

    对分组的介绍。

    具体的参数说明请参考《API网关用户指南》

  2. 创建API。(若目标API已创建完成,此步骤可忽略。)

    1. 单击目标API分组所在行的“API管理”,单击“新建API”,进入API信息设置页面。

    2. 设置“API名称”、“所属分组”、“类型”、“安全认证”等信息,确认信息无误后单击“下一步”。

      上架云商店的接口,只支持“APP认证”类型,否则无法上架,如您的接口支持APPCODE方式调用,请打开“支持简易认证”方式。

    3. 设置“请求协议”、“请求Path”、“匹配模式”、“Method”、“接口入参”等信息,单击“下一步”。

    4. 设置“协议”、“请求方式”、“使用VPC通道”、“后端服务地址”“后端超时时间”等信息,单击“下一步”。

    5. 设置“成功响应示例”“失败响应示例”等信息,单击“完成”。

      具体的参数说明请参考《API网关用户指南》

  3. 调测和发布API(若目标API已发布完成,此步骤可忽略)。

    1. 返回API管理页面,单击目标API所在行操作列的“调试”按钮,按照接口要求填写相关参数进行在线调试,并且需业务处理与预期一致,才能进行发布API上架,避免用户购买后无法使用。

    2. 返回API管理页面,单击目标API所在行右侧的“发布”按钮,进入API发布页面。

    3. 选择发布环境、输入发布API的说明后,单击“发布”按钮。

      若需要的发布环境不存在,单击“创建新环境”去创建新的发布环境。

相关文档