Manba项目API管理核心功能详解

Manba项目API管理核心功能详解

manba HTTP API Gateway 项目地址: https://gitcode.com/gh_mirrors/ma/manba

概述

Manba作为一个高性能API网关，其核心功能之一就是API管理。本文将深入解析Manba中API的各项属性和功能，帮助开发者更好地理解和使用Manba进行API管理。

API基础属性

唯一标识与基本信息

每个API在Manba中都有以下基础属性：

• ID：API的唯一标识符，系统自动生成
• Name：API的名称，便于识别和管理
• Status：API状态，包括UP(可用)和Down(不可用)两种状态

请求匹配规则

Manba通过以下属性匹配客户端请求：

1. URLPattern：URL路径匹配表达式，支持多种匹配模式：

   • 常量字符串匹配
   • 数字变量：(number):argName
   • 字符串变量：(string)
   • 枚举变量：(enum:value1|value2|value3)
   • 通配符：*

2. Method：HTTP方法(GET/POST/PUT/DELETE等)，*表示匹配所有方法

3. Domain：匹配请求的Host头

4. MatchRule：匹配规则组合方式：

   • MatchDefault：URLPattern && (Method || Domain)
   • MatchAll：URLPattern && Method && Domain
   • MatchAny：URLPattern || Method || Domain

高级功能特性

请求转发与重写

Manba支持将请求转发到后端服务，并提供了强大的URL重写功能：

1. URL重写表达式：支持使用变量动态构建目标URL

   • origin变量：访问原始请求的各个部分
   • param变量：访问URLPattern中定义的变量
   • depend变量：访问聚合请求的依赖结果

2. 参数校验：可对query、header、cookie、body等参数进行正则校验

3. 超时控制：可单独设置API级别的读写超时

聚合请求

Manba支持将单个客户端请求拆分为多个后端请求并聚合结果：

1. 支持并行或串行发送多个后端请求
2. 每个子请求可指定在最终结果中的属性名
3. 支持请求间的参数依赖

流量控制与熔断

1. QPS限制：基于令牌桶算法实现API级别的流量控制
2. 熔断机制：包含三种状态：
   • Open：正常状态，全量放行
   • Half：试探性恢复状态，部分放行
   • Close：熔断状态，拒绝所有请求

安全控制

1. IP访问控制：支持黑白名单机制
2. 权限控制：可通过插件实现自定义权限检查
3. 认证过滤：支持JWT等认证插件

特殊功能

默认返回值

当后端不可用时，可配置默认返回值：

• 包含HTTP状态码、响应体、Header和Cookie
• 可用于Mock测试或服务降级

模板渲染

支持通过RenderTemplate重新定义返回数据的结构和内容

WebSocket支持

提供实验性的WebSocket代理功能，可自定义Origin等参数

最佳实践建议

1. URL设计：合理使用URLPattern中的变量和通配符，保持API路径清晰
2. 匹配规则：根据业务需求选择合适的MatchRule
3. 流量控制：为关键API设置适当的QPS限制
4. 熔断配置：根据后端服务的承受能力设置合理的熔断阈值
5. 默认返回值：为关键业务API配置有意义的默认返回值

通过合理配置这些API属性，开发者可以构建出高性能、高可用的API网关服务，有效管理和保护后端API。

manba HTTP API Gateway 项目地址: https://gitcode.com/gh_mirrors/ma/manba