基础API概述
更新时间:2026-09-20
什么是基础 API
基础 API 是基础服务下的路由,通过配置匹配规则(路径、方法、Header、Query)与后端绑定,将请求转发到目标后端。基础 API 支持 HTTP 与 WebSocket 两种请求协议,可同时承载常规请求-响应接口与实时双向通信接口。
能力一览
| 能力 | 说明 |
|---|---|
| 归属服务 | 基础服务 |
| 请求协议 | HTTP / WebSocket,默认 HTTP |
| 路径匹配方式 | 精确匹配 / 前缀匹配 / 正则匹配 |
| 匹配条件 | 路径、请求方法(最多 10 个)、请求头(最多 10 条)、请求参数(最多 10 条) |
| 优先级 | 0-9999,0 为最高 |
| 后端服务类型 | 单服务实例 / 多服务实例(按权重,0-10000 按比值分流) |
| 支持的后端 | 域名后端、固定 IP 后端 |
| 高级策略 | 超时、URL 重写、重试 |
| 消费者认证 | 支持 API 级别开启,优先级高于所属服务 |
| 发布粒度 | API 级别(支持发布 / 下线) |
匹配优先级规则
多个 API 同时满足请求时按 优先级 生效,数字越小优先级越高。优先级相同时按以下默认规则匹配:
- 匹配方式优先级:精确匹配 > 前缀匹配 > 正则匹配;
- 路径段数匹配多的优先级高,例如
/a/b优先级大于/a; - Header 匹配数量多的优先级高,Header 优先级大于 Query;
- Query 匹配数量多的优先级高。
前提条件
使用流程
- 创建基础 API:配置匹配规则、后端与高级策略
- 发布与管理基础 API:发布 API 使其对外提供服务
- 按需为 API 绑定插件(限流、跨域、请求响应转换等)
- 通过基础 API 监控观察调用情况
相关文档
- 创建基础 API
- 发布与管理基础 API
- 基础 API 监控
- API 概述:三类 API 的能力对比。
评价此篇文章
