更新时间:2023-09-12 GMT+08:00
分享

创建API分组

API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。您在创建API前,需要先创建API分组。

目前支持两种创建分组方式:

  • 对外开放API时,您需要为API分组绑定自己的独立域名。
  • 一个API只能属于某一个API分组。
  • API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。

创建API分组

  1. 进入API中心服务页面
  2. 在左侧导航栏选择API网关代理 > API分组
  3. 单击右上角的“创建API分组”,选择下拉框中的“创建API分组”
  4. 在弹框中填写分组信息。

    表1 分组信息表

    信息项

    描述

    分组名称

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

    描述

    对分组的介绍。

  5. 单击“确定”,创建完成。

导入Swagger文件

  1. 进入API中心服务页面
  2. 在左侧导航栏选择API网关代理 > API分组
  3. 单击右上角的“创建API分组”,选择下拉框中的“导入Swagger文件”
  4. 在弹窗中选择本地路径下的API文件,然后单击“打开”导入文件。
  5. 填写导入信息。

    表2 导入API

    参数名称

    说明

    导入方式

    导入方式包含以下2种:

    • 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。
    • 选择已有分组:将API定义导入到一个已有的分组,导入过程中不会删除分组中已有的API,只是将新增的API导入分组。

    扩展覆盖

    勾选后,当导入API的扩展定义项名称(流控,访问控制,插件等)与已有的策略(流控,访问控制,插件等)名称相同时,会覆盖已有的策略(流控,访问控制,插件等)。

    是否覆盖

    勾选后,当导入API的名称与已有API的名称相同时,导入的API会覆盖已有的API。

    仅在“导入方式”选择“选择已有分组”时,需要选择是否覆盖。

  6. (可选)单击“全局配置(可选)”。

    1. 安全配置。请参考安全配置
    2. 后端请求配置。请参考1
    3. 确认无误后,单击“完成”,完成配置。

  7. 单击“立即导入”,在弹窗中选择是否现在发布API到环境。

    • 如果选择“现在发布”,还需要选择API要发布的环境,将API分组下的所有API发布到环境上。
    • 如果选择“稍后发布”,请参考发布API

  8. 单击“确定”,跳转到“API运行”页面,可查看分组下的API。

后续操作

创建API分组成功后,您还可以执行如表3的操作。

表3 后续操作

操作

说明

为API分组绑定独立域名

在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。

添加环境变量

通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。

修改分组信息

在分组所在行“操作”列,单击“编辑”,对分组名称及描述进行修改。

导出分组

在分组所在行“操作”列,单击“更多>导出”。

删除分组

在分组所在行“操作”列,单击“更多>删除”。

创建API

单击分组名称,在“API运行”页面,单击“创建API”。具体参数配置,参考创建API章节。

调试API

单击分组名称,在“API运行”页面,选择待调试的API,单击“调试”。

授权API

单击分组名称,在“API运行”页面,选择待授权的API,单击更多 > 授权

发布API

单击分组名称,在“API运行”页面,选择待发布的API,单击“发布”。

下线API

单击分组名称,在“API运行”页面,选择待下线的API,单击“下线”。

删除API

单击分组名称,在“API运行”页面,选择待删除的API,单击“删除”。

说明:

API先下线,才能删除。

为API添加策略

单击分组名称,在“API运行”页面,选择待添加策略的API,单击“添加策略”。具体参数配置,参考创建策略章节。

将分组内已发布的API上架至门户网站

任选以下三种方式之一操作,即可上架分组内已发布的API至API中心门户网站。

  • 方式一:在分组所在行“操作”列,单击“更多>上架”,跳转至“创建API资产”页面。
  • 方式二:单击分组名称,在“API运行”页面,单击右上角的“上架”,跳转至“创建API资产”页面。
  • 方式三:创建API资产时,“导入方式”选择“API网关”,然后选择API分组内已发布的API上架。

查看API的监控指标

单击分组名称,在“API运行”页面左侧选择API,在“监控视图”区域,查看API的各项监控指标。包括“请求次数”、“调用延时”、“数据流量”和“出错统计”。

分享:

    相关文档

    相关产品