Files
WonderQ-Project/docs
duanshuwen 6245159e7c feat: 添加后台登录验证码、记住密码功能,优化媒体资源与前端规范
- 新增后台登录图形验证码功能,完善登录安全防护
- 新增登录rememberMe参数,控制Refresh Token的会话持久化策略
- 实现OSS私有桶媒体URL自动签名,统一处理图片资源的临时访问签名
- 新增素材库数据库表与上传API,规范媒体资源管理流程
- 统一前端UI图标使用@element-plus/icons-vue,重构布局图标组件
- 登录页新增验证码输入、刷新功能,添加账号记忆与记住密码逻辑
- 更新全套文档,补充API契约、技术决策记录与集成流程说明
- 修复多个业务页面的图标展示问题,新增认证流程相关测试用例
2026-08-27 07:50:59 +08:00
..

WonderQ 文档索引

本目录只维护当前三端实际使用的契约和联调规则:WonderQ-AdminWonderQ-Admin-UI-VueWonderQ-MiniAPP。历史需求、旧管理端方案和重复接口说明不作为当前文档。

推荐阅读路径

后端或管理前端:

  1. api-response-contract.md:统一响应包裹、错误和 ID 规则
  2. admin-api-requirements.mdAdmin API 主契约
  3. module-config-api.md:首页与用车站点模块 CRUD 契约
  4. wanfa-api.md:玩法分类和路线管理契约
  5. detail-api.md:路线详情管理契约
  6. concierge-api.md:管家顾问管理契约

MiniAPP 或 Public API 联调:

  1. api-response-contract.md
  2. public-api.md:唯一 Public API 契约
  3. integration-workflow.md:启动、联调和验证流程

文档清单

文档 作用 主要读者
api-response-contract.md 三端统一 JSON 响应、错误、ID 和客户端解包规则 全部
integration-workflow.md 三端本地启动、联调顺序、接口变更流程和验证命令 全部
admin-api-requirements.md 当前 Admin API 主契约 后端、管理前端
module-config-api.md 站点页面模块 CRUD 唯一细节契约 后端、管理前端
wanfa-api.md 玩法分类和路线管理 API 后端、管理前端
detail-api.md 路线详情管理 API 后端、管理前端
concierge-api.md 管家顾问管理 API 后端、管理前端
public-api.md MiniAPP 使用的 Public API 唯一契约 后端、MiniAPP
decisions/ 当前重要技术决策记录 全部

文档边界

  • public-api.md 是 MiniAPP 对接后端的唯一 Public API 契约。
  • admin-api-requirements.md 是 Admin API 主契约;首页站点模块的字段和 CRUD 以 module-config-api.md 为准。
  • 玩法、详情和管家领域分别以对应补充契约为准,不在联调文档中重复维护字段。
  • integration-workflow.md 只记录流程、验证和风险,不定义新的接口字段。
  • 首页站点模块的 Admin API 统一以 module-config-api.md 为准。
  • docs/superpowers/ 仅保存仍在使用的设计参考,不作为接口契约入口。

安全约束

  • 文档示例不得写入真实 Token、JWT secret、客服链接、企业 ID、手机号或生产环境变量值。
  • .env.env.local 和生产配置不进入文档目录。
  • 涉及重置数据、发布、回滚、迁移或生产操作的文档,必须明确风险和验证方式。