R
cfapi.aog.cc API 文档中心
v1.9.7

cfapi.aog.cc 统一 API 网关

企业级多租户 RBAC 管理平台。提供鉴权、插件、多协议网关、实时监控等能力,助力业务快速接入。

53
REST 端点
4
接入协议
100%
API 化
24/7
在线服务

核心能力

平台将通用能力抽象为标准化 API,支持多租户、插件化扩展、统一鉴权与实时事件。

🔐

统一鉴权

JWT Bearer 认证 + RBAC 权限控制,公开接口标记 security: [],业务接口统一 Authorization 头。

🧩

插件生态

支持 zip 上传、目录扫描、远程 API 注册、插件市场 4 种上架方式,业务与核心框架完全隔离。

🌐

多协议网关

REST / GraphQL / WebSocket / Socket.IO / SSE / Anthropic / OpenAI / OpenRouter 代理统一接入。

📊

实时事件

WebSocket / SSE 事件流、网关状态监控、实时日志流,运维数据一目了然。

🏢

多租户 RBAC

多租户数据隔离与角色权限管理,支持后台一键管理。

🚀

一键升级

平滑升级机制,业务数据/功能代码完全隔离,框架升级不影响业务逻辑。

API 概览

平台接口采用统一设计规范,所有业务接口均返回 { code, message, data } 结构。

正在加载 API 概览…

鉴权

  • 公开接口:无需 token,文档中标记 security: []
  • 业务接口:请求头带 Authorization: Bearer <JWT>

统一响应体

{ "code": 0, "message": "ok", "data": {} }

其中 code=0 表示成功,其余为业务错误码。

错误码

code含义
0成功
40000参数错误
40100未认证
40300无权限
40400不存在
40900冲突
50000内部错误

平台文档

面向使用者的两份核心文档,随平台更新同步发布。

铁律 v0.5.15

平台最高优先级的约束与规范清单。

打开铁律 v0.5.15 →

铁律目录

说明书 平台使用说明书

从部署到各功能模块的完整操作说明。

打开使用说明书 →

说明书目录

快速开始

所有业务接口统一返回 { code, message, data },其中 code=0 表示成功。

请求示例
# 获取版本信息
curl -s https://cfapi.aog.cc/api/version

# 业务接口(需先登录获取 JWT)
curl -H "Authorization: Bearer <JWT>" \
     https://cfapi.aog.cc/api/users/me

接口浏览器

点击下方接口展开详情,可在线调试。