refactor: 优化API路由和响应模型 feat(admin): 添加App用户管理接口 feat(sms): 实现阿里云短信服务集成 feat(email): 添加SMTP邮件发送功能 feat(upload): 支持文件上传接口 feat(rate-limiter): 实现手机号限流器 fix: 修复计算步骤入库问题 docs: 更新API文档和测试计划 chore: 更新依赖和配置
29 lines
2.2 KiB
Markdown
29 lines
2.2 KiB
Markdown
## 目标
|
||
- 汇总所有前后端需求与 API 到一个文档,其他分散文档删除,仅保留总览,便于统一查看与维护。
|
||
|
||
## 操作与产物
|
||
- 新增单一文档:`docs/估值二期-需求与API总览.md`
|
||
- 内容包含:
|
||
1) 概述与约定(认证、响应包装、错误码、前缀)
|
||
2) 数据实体(InvoiceHeader、PaymentReceipt、TransactionRecord、Valuation、AppUser、Complaint、SMSMessage)与字段定义
|
||
3) 用户端流程与 API(登录/首页摘要、评估提交/校验/状态、估值记录下载与分享、个人中心-对公转账、发票抬头/类型、发票列表与详情、剩余次数、投诉与短信、批量与异步Job)
|
||
4) 管理端流程与 API(交易管理记录:列表/详情/状态/邮件/开票/批量;审核列表;用户管理)
|
||
5) 前端对接映射(`web/src/api/index.js` 现有与新增占位)
|
||
6) 请求/响应示例与字段校验(重点:抬头管理、对公转账、交易管理记录)
|
||
7) 性能与限制(分页、异步、频率)
|
||
- 删除分散文档:
|
||
- `web/docs/项目结构.md`、`web/docs/技术架构.md`、`web/docs/关键模块说明.md`、`web/docs/接口约定与预留.md`
|
||
- `app/docs/项目结构.md`、`app/docs/技术架构.md`、`app/docs/关键模块说明.md`、`app/docs/接口约定与预留.md`
|
||
|
||
## 你提出的新增明确项(将详列在文档中)
|
||
- 抬头管理字段(必填项标注):公司名称、公司税号、注册地址、注册电话、开户银行、银行账号、邮箱
|
||
- 对公转账(用户端):上传图片(付款凭证)+ 选择发票抬头 + 开票类型(电子/纸质、专票/普票)
|
||
- 交易管理记录(管理端):提交时间、付款凭证、手机号、微信号、公司名称、公司税号、注册地址、注册电话、开户银行、银行账号、接收邮箱、开票类型、状态
|
||
- 状态枚举:pending/verified/issued/rejected 等
|
||
|
||
## 执行步骤
|
||
1. 创建总览文档并写入上述结构内容与端点清单
|
||
2. 迁移现有 app/web 文档中的有效信息到总览文档
|
||
3. 删除分散文档,仅保留总览
|
||
|
||
——请确认上述方案,确认后我将生成唯一的总览文档并删除分散文档。 |