Files
CKB-Interface/application/store/APIFOX_UPLOAD_SUCCESS.md
2026-03-24 10:39:16 +08:00

2.5 KiB
Raw Blame History

Apifox 接口上传成功

📋 上传信息

  • 项目ID: 6037107
  • 项目名称: AI数智员工系统
  • 目标目录: 门店端-新版 (Folder ID: 78015216)
  • 上传时间: 2026-02-05
  • 状态: 已验证,接口在正确目录下

已上传接口列表

1. 账号密码登录

  • 方法: POST
  • 路径: /v2/store/auth/login
  • API ID: 415781876
  • 描述: 使用账号和密码进行登录支持H5和APP端
  • 标签: 认证

请求参数:

{
  "account": "账号/手机号",
  "password": "密码",
  "typeId": 2,
  "deviceId": ""
}

2. 免密登录设备ID

  • 方法: GET
  • 路径: /v2/store/auth/login
  • API ID: 415781877
  • 描述: 基于设备ID进行免密登录适用于APP端
  • 标签: 认证

请求参数:

?deviceId=设备IMEI

3. 发送短信验证码

  • 方法: POST
  • 路径: /v2/store/auth/send-code
  • API ID: 415781878
  • 描述: 发送短信验证码到手机
  • 标签: 认证

请求参数:

{
  "mobile": "手机号",
  "type": "login"  // login/register/reset
}

功能特性:

  • 60秒发送频率限制
  • 验证码5分钟有效期
  • 支持阿里云短信服务

4. 手机验证码登录

  • 方法: POST
  • 路径: /v2/store/auth/mobile-login
  • API ID: 415781879
  • 描述: 使用手机号和验证码进行登录
  • 标签: 认证

请求参数:

{
  "mobile": "手机号",
  "code": "验证码",
  "is_encrypted": false
}

功能特性:

  • 自动注册新用户(首次登录)
  • 验证码验证后自动失效

🔗 访问链接

Apifox 项目地址: https://app.apifox.com/project/6037107


📝 后续操作建议

  1. 完善接口文档

    • 在 Apifox 中为每个接口添加更详细的响应示例
    • 添加错误码说明400, 401, 404等
    • 添加接口调用示例
  2. 配置Mock数据

    • 为每个接口配置Mock规则
    • 方便前端开发时独立测试
  3. 创建测试用例

    • 为每个接口创建自动化测试用例
    • 配置环境变量(开发/测试/生产)
  4. 团队协作

    • 邀请团队成员加入项目
    • 设置接口评审流程

🛠️ 上传工具

使用的上传脚本: upload_to_apifox.py

如需重新上传或更新接口,可以:

cd F:\karuo\yi-shi\Server\application\store
python upload_to_apifox.py

📞 技术支持

如有问题,请联系技术团队。