帮你快速理解、总结文档立即下载

创建 API

最近更新时间:2026-08-06 17:44:30
我的收藏

操作场景

当创建一个 API 服务 后,您可以开始编辑其具体 API 行为,包括 API 的请求路径(API Path)、请求方法、分组、鉴权策略、请求参数、策略配置、API 绑定的后端服务类型等操作,详细见本文介绍。

操作步骤

1. 登录 腾讯轻联控制台,在左侧导航栏选择 API > API 管理,单击已创建服务的操作列的新建 API,进入 API 创建页面。

2. 在创建 API 界面完成以下配置项。
2.1 基础配置

API 名称:描述支持自定义。
分组:可选择默认分组、新建分组。
描述:可选。
请求路径:api 地址中的请求路径。
请求方法:支持 GET、POST、PATCH、PUT、DELETE、HEAD。
鉴权策略:支持 NoAuth、BasicAuth、OAuth2.0、HMAC。
后端服务类型:支持集成流、第三方服务、数据库、Mock 类型。
当选择类型为数据库时,支持新建或选择 MySQL、Oracle、PostgreSQL、SQL Server 类型的数据源。

请求参数:可自行添加请求参数,参数类型包括 integer、string、number、boolean、array、object,最多添加30条。



策略配置: API 管理支持多样的策略配置,如下。
IP 访问限制
支持针对 API 接口粒度设置 IP 访问黑名单/白名单。



基础流量控制
支持针对 API 接口粒度设置基础流量控制,包括 API 请求频率(该 API 被请求的最大频率)和源 IP 请求频率(该 API 被同一源 IP 请求的最大频率),周期时长包括:秒、时、日、7日、30日、365日。



请求包大小限制
支持针对 API 接口粒度设置请求包大小限制,指定请求 body 大小。



防重放攻击
支持针对 API 接口粒度设置防重放攻击,开启后需配置 header 请求参数 X-Ca-Nonce 和 X-Ca-Timestamp,并在每次请求时传入这两个参数:X-Ca-Timestamp 代表请求时刻时间戳(秒级),X-Ca-Nonce 代表请求的唯一标识(每个有效时长内不允许重复)。基于这两个参数来保障有效时长内请求的唯一性,保障 API 安全。
nonce 有效时长代表底层存储每个 API 请求唯一标识的时长,如果太大可能影响校验性能。并且会将 nonce 有效时长视作正常 API 请求从发出到到达服务端的最大时间差,如果太小可能误判正常请求。



熔断降级
支持针对 API 接口粒度设置熔断降级策略,当每个统计周期内该 API 发生的错误(按错误定义)达到错误次数后,即会触发熔断并维持断路持续时长,此期间所有请求均转发到降级后端配置,从而适应 API 请求高并发场景。



2.2 后端配置

集成流:需选择 webhook 触发的且在运行中的集成流。
后端超时时间:可默认系统预设的,也可自定义。
请求方法:根据用户需求选择即可。支持 GET、POST、PATCH、PUT、DELETE、HEAD。
参数定义:支持配置前后端参数映射。
2.3 响应配置
支持配置响应示例,以及错误码配置。



3. 配置全部完成后,单击完成即可在 API 列表看到已经创建好的 API 信息。