Skip to content

API 网关

API 网关为平台的开放能力提供统一的管理和访问入口,支持完整的 API 生命周期管理。用户可以在此进行接口配置、权限管控以及调用监控等操作。

API 管理

API 管理用于创建和维护对外开放的 API。用户在创建 API 时,需要配置前端 API 请求规则以及对应的后端服务,实现将内部服务能力以标准接口形式对外提供。 API 管理

创建API

  • 第一步:为 API 输入名称,并选择其所属分组。若需要创建新分组,可前往分组管理中进行操作。

创建API1

  • 第二步:后端服务配置,设置实际服务地址、请求方式、参数等,可在以下三种类型中选择:系统 API、零代码 API 或自定义 API。

创建API2

配置项说明
后端服务地址指定API请求的服务端来源:
• 系统类型:从能力开放平台已启用的服务包中选择。
• 零代码平台:从平台智能应用所提供的API地址中选择。
• 自定义:配置自定义服务地址,通常用于通过API网关集成外部服务。
后端请求Path指定API的具体请求路径:
• 系统类型:从所选服务包中包含的API路径中选择。
• 零代码平台:从智能应用所提供的API具体路径。
• 自定义:配置自定义的服务路径,与自定义服务地址配合使用。
请求Method自定义类型可定义API的请求动作。根据后端接口的定义,在下拉列表中选择对应的HTTP方法,如 GET、POST、PUT 或 DELETE。系统类型和零代码平台类型由选择的API决定。
后端服务参数配置后端服务参数
常量参数配置常量参数,可选
  • 第三步:前端 API 请求定义,配置请求路径、请求方法、参数映射关系、认证方式等外部调用规范,实现前端请求与后端服务的映射

创建API3

  • 第四步:定义API 返回结果,配置错误码和成功/失败响应示例,支持JSON格式。

创建API4

分组管理

分组管理用于管理 API 的分组,用户可以根据业务需求创建、编辑和删除分组,方便对 API 进行分类管理。支持通过密钥复制分组接口。 分组管理

分组详情

API 授权

配置接口访问权限,实现细粒度的 API 安全管控与授权策略。根据业务需求,为不同外部应用提供API访问权限。 API 授权

授权详情

流量控制

设置接口调用频率与并发限制,有效保障系统稳定性与服务质量。 流量控制

流量详情

创建控制策略

支持设置秒、分、时或天单位时间内API 的访问次数。 创建策略

访问控制

配置接口访问规则,支持基于 IP的访问策略设置。 访问控制

访问控制详情

创建规则

支持创建允许或禁止规则,可设置多IP地址。 创建访问控制

统计图表

可视化展示 API 调用数据与使用趋势,辅助性能监控与决策分析。支持频率分布图和热度分布图两种图标。 频率图

热度图