chore: 以本地为准,上传全部并替换 GitHub
This commit is contained in:
44
开发文档/5、接口/接口定义规范.md
Normal file
44
开发文档/5、接口/接口定义规范.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# 神射手数据中台 - 接口定义规范
|
||||
|
||||
> 📅 更新: 2026-01-31
|
||||
|
||||
---
|
||||
|
||||
## 一、统一响应
|
||||
|
||||
```typescript
|
||||
// 成功
|
||||
{ success: true, data: {...} }
|
||||
|
||||
// 失败
|
||||
{ success: false, error: "错误信息" }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 二、核心API
|
||||
|
||||
| 路由 | 方法 | 说明 |
|
||||
|:---|:---|:---|
|
||||
| /api/ai-chat | GET/POST | AI对话 |
|
||||
| /api/data-sources | GET | 数据源 |
|
||||
| /api/tags | GET | 标签 |
|
||||
| /api/traffic-packages | GET/POST | 流量池 |
|
||||
| /api/crowd-pools | GET | 人群圈选 |
|
||||
| /api/monitoring | GET | 系统监控 |
|
||||
|
||||
---
|
||||
|
||||
## 三、请求规范
|
||||
|
||||
| 项目 | 要求 |
|
||||
|:---|:---|
|
||||
| Content-Type | application/json |
|
||||
| 分页 | page=1, limit=20 |
|
||||
| 动作 | action=xxx (如 pools, export) |
|
||||
|
||||
---
|
||||
|
||||
## 四、关联文档
|
||||
- [API清单与核心逻辑.md](./API清单与核心逻辑.md)
|
||||
- [存客宝对接规范.md](./存客宝对接规范.md)
|
||||
Reference in New Issue
Block a user