Преглед на файлове

docs: add documentation map + test accounts + API endpoints to README

DoTouch Dev преди 2 седмици
родител
ревизия
cf5f7118ae
променени са 1 файла, в които са добавени 59 реда и са изтрити 0 реда
  1. 59 0
      README.md

+ 59 - 0
README.md

@@ -56,11 +56,70 @@ pnpm typecheck
 
 复制 `.env.example` 到 `.env` 并填写真实值。
 
+## 测试账号(本地开发)
+
+| 账号 | 用途 | 邮箱 | 密码 |
+|---|---|---|---|
+| 用户 | 官网 / 用户控制台 | `demo.user@dotouch.ai` | `User2026!` |
+| 运营 | 平台管理后台 | `admin@dotouch.ai` | `Admin2026!` |
+| 测试主账号 | 接口联调(admin) | `test-e2e@dotouch.ai` | `Test1234` |
+
 ## API 端点
 
 | 方法 | 路径 | 说明 |
 |------|------|------|
 | GET | /v1/health | 健康检查 |
+| POST | /v1/auth/send-code | 发送邮箱验证码(8 位,15 分钟有效) |
+| POST | /v1/auth/register | 注册(邮箱+密码+验证码) |
+| POST | /v1/auth/login | 登录(5 次失败/15 分钟限流) |
+| POST | /v1/auth/forgot · /reset | 密码重置 |
+| POST | /v1/keys · /v1/keys/:id/rotate | API Key 创建 / 轮换 |
+| PUT | /v1/keys/:id/limits | Key 用量限额配置 |
+| PUT | /v1/account/limits | 账号级用量限额 |
+| GET | /v1/usage/quota | 用量进度(限额进度条数据) |
+| GET | /v1/models | 模型目录(236 全量) |
+| POST | /v1/chat/completions | OpenAI 兼容网关(SSE 流式) |
+| GET | /v1/usage · /v1/usage/summary | 用量明细 / 日聚合 |
+| GET | /v1/wallet | 钱包余额与流水 |
+| POST | /v1/wallet/deposit | 充值(创建支付订单) |
+| GET | /v1/wallet/orders | 充值订单列表 |
+| POST | /v1/payments/webhook/:provider | 支付回调(webhook) |
+| GET | /v1/admin/* | 管理后台(stats/users/models/quotas) |
+
+## 文档树(Documentation Map)
+
+```
+docs/
+├── README 指南:本文件(根 README 见上)
+├── VERSIONING.md            版本与迭代规范(时间戳 + 递增版本号)
+├── CHANGELOG.md             变更记录(按功能迭代)
+│
+├── requirements/            需求文档
+│   └── usage-quota-requirements-v1.0.md   用量提醒与限制需求规格(定稿)
+│
+├── testing/                 测试体系
+│   ├── test-cases-v1.0.0.md         端到端测试用例(10 组)
+│   ├── feature-acceptance-matrix.md 功能清单与验收标准(F-01~F-14,90+ 用例)
+│   └── test-run-log.md              测试运行日志(每轮结果 + 缺陷 + 反馈跟踪)
+│
+├── compliance/              合规调研
+│   ├── top3-transit-compliance-20260808.md    全球 Top3 中转站合规对比
+│   └── alibaba-bailian-terms-20260808.md      阿里云百炼条款(转售需书面许可)
+│
+├── models/                  模型调研(阿里云百炼真实扫描)
+│   ├── dashscope-models-20260808.json    236 个在售模型全量清单
+│   └── dashscope-pricing-20260808.md     价格与收费方式(含 7 折策略)
+│
+└── design/                  设计资产与审阅稿
+    ├── logo-*.html                  Logo 概念迭代(v1.0.0→v1.3.0→终稿)
+    ├── logo-final-b1-*.html         B1 终稿规范(安全区/配色/禁用用法)
+    ├── assets/                      品牌素材(SVG×5 / 质感稿 / 动态视频)
+    ├── web-v1.1.0/                  官网静态稿(6 页多语言 + 模型大全子页)
+    └── console-v1.0.0/              控制台设计稿(用户控制台 + 管理后台)
+
+apps/web/src/components/     官网落地组件(SiteHeader/Hero/AuthModal 等 15 个)
+apps/api/src/                后端模块(auth/keys/wallet/payments/gateway/quota/admin)
+```
 
 ## 许可