index.js - HTTP API文档

生成时间: 2026-01-28T13:42:12.206Z 源文件: index.js API端点数量: 62

HTTP API 文档

概述

这是一个基于Express.js的电商系统API，包含商品管理、订单处理、佣金结算、用户提现等功能。所有路由都使用app.all()方法，支持多种HTTP方法。

路由分组

1. 商品操作

2. 订单操作

3. 管理员订单管理

4. 佣金结算管理

5. 用户账户管理

6. 提现管理

7. 管理员用户管理

8. 管理员佣金管理

9. 商品管理

中间件使用情况

1. urlParser

• 作用: 解析请求URL参数
• 使用位置: 所有路由的第一个中间件

2. session_filter

• 作用: 验证用户会话状态
• 使用位置: 需要用户登录的路由

3. filter_manager

• 作用: 验证管理员权限
• 验证方式: 检查admin_password参数是否匹配manager_key文件中的密码
• 使用位置: 需要管理员权限的路由

业务数据存储格式说明

1. 商品数据存储

• 存储位置: /product/ 目录下的文件
• 缓存位置: /cached/ 目录下的JSON文件
• 元数据: product_meta.md 文件定义商品结构
• 缓存格式:

{
  "product_info": {
    "product_id": "string",
    "product_name": "string",
    "price": "number",
    "stock": "number",
    "category": "string",
    "is_active": "boolean",
    "commission_rate": "number",
    "description": "string"
  },
  "cache_time": "ISO日期字符串",
  "user_id": "string",
  "created_at": "ISO日期字符串"
}

2. 订单数据存储

• 存储位置: /order/ 目录下的JSON文件
• 文件命名: order_YYYYMMDD_RRRRR.json
• 数据格式:

{
  "order_id": "string",
  "customer_id": "string",
  "promoter_id": "string",
  "products": "array",
  "total_amount": "number",
  "status": "string",
  "payment_status": "string",
  "commission_amount": "number",
  "commission_status": "string",
  "order_time": "ISO日期字符串",
  "shareholder_info": "object"
}

3. 用户流水存储

• 存储位置: /user_flow/ 目录下的JSON文件
• 文件命名: 用户ID.json
• 数据格式:

[
  {
    "flow_id": "string",
    "user_id": "string",
    "amount": "number",
    "type": "string",
    "description": "string",
    "balance": "number",
    "timestamp": "ISO日期字符串"
  }
]

4. 结算记录存储

• 存储位置: /settlement/ 目录下的JSON文件
• 文件命名: SETTLE_YYYYMM_TIMESTAMP_PROMOTERID.json
• 数据格式: 包含结算批次、推广人、佣金总额、订单列表等信息

5. 提现记录存储

• 存储位置: /withdrawal/ 目录下的JSON文件
• 文件命名: WITHDRAW_YYYYMM_PROMOTERID_TIMESTAMP.json
• 数据格式: 包含提现金额、状态、时间、推广人等信息

6. 提现申请存储

• 存储位置: /withdrawal_apply/ 目录下的JSON文件
• 文件命名: USER_WITHDRAW_YYYYMMDD_HHMMSS_TIMESTAMP_RANDOM.json
• 数据格式: 包含申请信息、用户信息、状态、处理记录等

通用响应格式

所有API返回统一的JSON响应格式：

{
  "ret": "boolean, 表示操作是否成功",
  "msg": "string, 返回消息",
  "data": "object/array, 返回的数据"
}

状态码说明

• 200: 请求成功
• 400: 参数错误
• 401: 权限不足
• 404: 资源不存在
• 500: 服务器内部错误

注意事项

1. 所有需要管理员权限的接口必须提供有效的admin_password参数
2. 用户相关操作需要有效的user_id和会话验证
3. 日期参数格式为YYYY-MM-DD
4. 分页参数：page从1开始，limit默认10-20条

检测到的API端点

元数据

{
  "sourceFile": "index.js",
  "generatedAt": "2026-01-28T13:42:12.206Z",
  "endpointCount": 62,
  "hasHttpApis": true
}

本文档由HTTP API文档生成Agent自动生成

index.js - HTTP API文档

生成时间: 2026-01-28T13:38:39.041Z 源文件: index.js API端点数量: 20

HTTP API 文档

路由分组：用户管理 (rtagent/user)

所有API端点均使用 app.all() 方法，支持多种HTTP方法。所有路由都经过 urlParser 中间件处理请求参数。

API端点表格

中间件说明

1. urlParser: 解析请求参数（路径参数、查询参数、请求体）
2. session_filter: 会话过滤中间件（仅部分路由使用）

业务数据存储格式

用户信息文件格式

用户信息存储在文本文件中，格式为键值对：

phone:13800138000
password:12345678
user_id:user_abc123
created_at:2024-01-01T00:00:00.000Z
created_timestamp:1704067200000
last_login:2024-01-01T00:00:00.000Z
promoter_id:user_xyz789
修改用户名为：张三
修改密码为：87654321

手机号映射文件格式 (user_phone)

存储手机号与用户ID的映射关系：

13800138000:user_abc123:1704067200000
13800138001:user_def456:1704067300000

缓存文件格式 (cached/)

JSON格式缓存用户信息，存储在 cached/{user_id}.json 文件中：

{
  "phone": "13800138000",
  "user_id": "user_abc123",
  "username": "张三",
  "created_at": "2024-01-01T00:00:00.000Z",
  "promoter_id": "user_xyz789",
  "balance": 100.00,
  "total_commission": 50.00,
  "is_active": true
}

元数据文件 (user_info_meta.md)

包含用户信息字段的元数据定义，用于AI解析用户信息文件。

数据验证规则

1. 手机号格式: /^1[3-9]\d{9}$/
2. 密码格式: /^[a-zA-Z0-9]{8}$/ (8位数字和英文字符)

缓存机制

系统使用文件缓存机制：

• 缓存位置: cached/{user_id}.json
• 缓存失效: 当用户文件修改时间晚于缓存文件时失效
• 缓存更新: 用户信息修改后自动删除缓存

检测到的API端点

元数据

{
  "sourceFile": "index.js",
  "generatedAt": "2026-01-28T13:38:39.041Z",
  "endpointCount": 20,
  "hasHttpApis": true
}

本文档由HTTP API文档生成Agent自动生成