5.6 KiB
5.6 KiB
API上传总结 ✅
📋 上传信息
- 项目ID: 6037107
- 项目名称: AI数智员工系统
- 上传时间: 2026-02-05
- 状态: ✅ 大部分接口已成功更新/上传
✅ 登录接口(登录相关目录 - 78092117)
| 接口名称 | 方法 | 路径 | API ID | 状态 |
|---|---|---|---|---|
| 账号密码登录 | POST | /v2/store/auth/login |
415781876 | ⚠️ 更新失败(需手动更新) |
| 免密登录(设备ID) | GET | /v2/store/auth/login |
415781877 | ⚠️ 更新失败(需手动更新) |
| 发送短信验证码 | POST | /v2/store/auth/send-code |
415781878 | ✅ 已更新 |
| 手机验证码登录 | POST | /v2/store/auth/mobile-login |
415781879 | ✅ 已更新 |
说明:
- 前2个接口更新失败,可能是Apifox API限制,需要在Web界面手动更新描述
- 后2个接口已成功更新
✅ Agent接口(Agent管理目录 - 78106557)
| 接口名称 | 方法 | 路径 | API ID | 状态 |
|---|---|---|---|---|
| 获取Agent模块列表 | GET | /v2/store/agent/modules |
415861964 | ⚠️ 更新失败(需手动更新) |
| 更新模块状态 | PUT | /v2/store/agent/modules/{moduleCode}/status |
415861967 | ✅ 已更新 |
说明:
- 获取Agent模块列表接口更新失败,需要在Web界面手动更新描述
- 更新模块状态接口已成功更新
重要变更:
- ✅ 现在deviceId自动从JWT Token获取,无需手动传递
- ✅ 接口会自动从
request->userInfo获取设备信息
✅ 流量采购接口(门店端-新版目录 - 78015216)
| 接口名称 | 方法 | 路径 | API ID | 状态 |
|---|---|---|---|---|
| 获取可购买的流量池包列表 | GET | /v2/store/traffic/packages |
415976880 | ✅ 已创建 |
| 获取流量池包详情 | GET | /v2/store/traffic/packages/{id} |
415976882 | ✅ 已创建 |
| 购买流量 | POST | /v2/store/traffic/packages/{id}/purchase |
415977273 | ✅ 已创建 |
| 获取已购买的流量列表 | GET | /v2/store/traffic/purchased |
415976885 | ✅ 已创建 |
| 获取购买记录列表 | GET | /v2/store/traffic/purchase-records |
415976886 | ✅ 已创建 |
| 获取购买记录详情 | GET | /v2/store/traffic/purchase-records/{id} |
415976889 | ✅ 已创建 |
| 获取流量采购统计 | GET | /v2/store/traffic/statistics |
415976892 | ✅ 已创建 |
说明:
- ✅ 所有7个流量采购接口已成功创建
- 📁 接口位于"门店端-新版"目录下,后续可移动到"流量采购"子目录
📊 统计
- 登录接口: 4个(2个已更新,2个需手动更新)
- Agent接口: 2个(1个已更新,1个需手动更新)
- 流量采购接口: 7个(全部已创建)✅
总计: 13个接口,10个已成功,3个需手动更新
🔧 需要手动更新的接口
以下接口需要在Apifox Web界面手动更新描述:
-
POST /v2/store/auth/login (ID: 415781876)
- 更新描述:说明现在使用JWT Token生成(30天有效期)
-
GET /v2/store/auth/login (ID: 415781877)
- 更新描述:说明现在使用JWT Token生成(30天有效期)
-
GET /v2/store/agent/modules (ID: 415861964)
- 更新描述:说明deviceId自动从JWT Token获取,无需手动传递
🔗 访问链接
Apifox 项目地址: https://app.apifox.com/project/6037107
目录结构:
门店端-新版 (78015216)
├── 登录相关 (78092117)
│ ├── POST /v2/store/auth/login (需手动更新)
│ ├── GET /v2/store/auth/login (需手动更新)
│ ├── POST /v2/store/auth/send-code ✅
│ └── POST /v2/store/auth/mobile-login ✅
├── Agent管理 (78106557)
│ ├── GET /v2/store/agent/modules (需手动更新)
│ └── PUT /v2/store/agent/modules/{moduleCode}/status ✅
└── 流量采购接口(根目录)
├── GET /v2/store/traffic/packages ✅
├── GET /v2/store/traffic/packages/{id} ✅
├── POST /v2/store/traffic/packages/{id}/purchase ✅
├── GET /v2/store/traffic/purchased ✅
├── GET /v2/store/traffic/purchase-records ✅
├── GET /v2/store/traffic/purchase-records/{id} ✅
└── GET /v2/store/traffic/statistics ✅
📝 后续操作(重要)
⚠️ 需要手动创建目录
流量采购管理目录未创建(Apifox API限制)
操作步骤:
- 打开:https://app.apifox.com/project/6037107
- 在"门店端-新版"目录下右键 → 新建文件夹 → 命名为"流量采购管理"
- 将7个流量采购接口拖拽到该目录
详细指南:请查看 流量采购目录创建指南.md
📝 后续建议
-
完善接口文档
-
完善接口文档
- 为每个接口添加详细的请求/响应示例
- 添加错误码说明
- 添加接口调用示例
-
配置Mock数据
- 为每个接口配置Mock规则
- 方便前端开发时独立测试
-
创建测试用例
- 为每个接口创建自动化测试用例
- 配置环境变量(开发/测试/生产)
🛠️ 使用的脚本
update_and_upload_apis.py- 主要上传脚本fix_failed_apis.py- 修复失败接口脚本
✨ 总结
已完成的工作:
- ✅ 登录接口已更新(部分需手动完善)
- ✅ Agent接口已更新(部分需手动完善)
- ✅ 流量采购接口已全部创建
剩余工作:
- ⏳ 在Web界面手动更新3个接口的描述(5分钟完成)
- ⏳ 创建"流量采购"目录并移动接口(可选)
访问链接:
- Apifox项目: https://app.apifox.com/project/6037107