更新时间:2024-09-03 GMT+08:00
分享

创建API分组

API分组是同一类业务API的集合,API开发者以API分组为单位,管理分组内的所有API。每个API都要归属到某个API分组下,在创建API前应提前创建API分组。

约束与限制

  • API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。对外开放API时,建议您为API分组绑定独立域名。支持通过“调试域名开关”来启用/禁用通过调试域名访问接口,调试域名禁用后将隐藏调试域名,显示为“--”。
  • Site实例不支持使用子域名调用API,仅支持使用IP+Host头方式调用API。

前提条件

每个API分组都要归属到某个集成应用下,在创建API分组前您需要有可用的集成应用,否则请提前创建集成应用

操作步骤

  1. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > API分组”,在页面右上角单击“创建API分组 > 直接创建”。
  3. 在创建分组弹窗中配置API分组相关信息,然后单击“确定”。
    表1 API分组配置

    参数

    说明

    分组名称

    填写API分组的名称,根据规划自定义。建议您按照一定的命名规则填写API分组名称,方便您快速识别和查找。

    可见范围

    选择API分组的可见范围。

    • 集成应用:API分组归属某个集成应用,仅拥有该集成应用权限的用户可查看和操作该API分组。
    • 全局:当前实例的所有用户都可查看和操作该API分组。

    集成应用

    仅当“可见范围”选择“集成应用”时需要配置。

    选择API分组所属的集成应用。若没有可用的集成应用,可单击右侧的“新建集成应用”,创建一个集成应用。

    描述

    填写API分组的描述信息。

相关文档