guzhi/.trae/documents/更新用户端 API 到文档.md
邹方成 cc352d3184 feat: 重构后端服务并添加新功能
refactor: 优化API路由和响应模型
feat(admin): 添加App用户管理接口
feat(sms): 实现阿里云短信服务集成
feat(email): 添加SMTP邮件发送功能
feat(upload): 支持文件上传接口
feat(rate-limiter): 实现手机号限流器
fix: 修复计算步骤入库问题
docs: 更新API文档和测试计划
chore: 更新依赖和配置
2025-11-19 19:36:03 +08:00

1.4 KiB
Raw Blame History

目标

  • 将“用户端”API补齐内容更新到现有文档便于你审阅。

更新范围

  • 修改 app/docs/接口约定与预留.md:新增“用户端 API”章节覆盖登录/首页/评估/个人中心/估值记录/通知/批量与异步,与错误码和校验对齐。

  • 修改 web/docs/接口约定与预留.md:新增“前端对接(用户端)”章节,列出与 web/src/api/index.js 的映射与新增端点占位,确保路径与请求方式一致。

文档结构变更

  • app/docs/接口约定与预留.md

    • 新增:

      • “用户端 API 概览”

      • “认证与首页”

      • “评估提交与引导提示”

      • “估值记录与分享”

      • “个人中心:汇款凭证/发票抬头与类型/发票列表与详情”

      • “剩余估值次数”


  • web/docs/接口约定与预留.md

    • 新增:

      • “用户端对接路径”与现有 invoice/*valuation/*app-user/* 的映射

      • 新增端点建议(如 app-valuation/*invoice/headersinvoice/{id}/receiptjobs/{id})的前端占位说明

风格与格式

  • 统一中文、RESTful端点风格示例以JSON格式。

  • 保持与现有文档用语一致Success/Fail、token、code===200

交付

  • 完成上述两处文档更新不新增新文档文件更新内容可直接在IDE中查看。