docs: 清掉三处"会静默过期"的小账 + check-test-profile 加固(F-98)
一、附录 A 从"手抄表"改成"可再生成的命令"
check-api-parity.py 加 --extra,现算"代码有、契约 §4 没有"的接口 = 41 个
(旧手抄表写 83/62/21,已差近一倍,而且没人会记得回来改它)。
并按"谁去改什么"分六类 —— 只有 E 类(8 个)要客户定口径,其余是文档侧补记。
二、F-6 已修:frontend-pc 的 Mock 说明
AGENTS.md 那句改正之外,连带修了 .agents/skills/project-api/SKILL.md ——
它整篇仍以 vite-plugin-mock / mock/** 为主线,而该项目里 mock/ 目录与插件都已删除。
只改指路牌、不改路的尽头,等于没改。
三、docs/03 两处文档内部口径冲突加 ⚠️ 注(不改口径,只把冲突摆明)
§2 notifyBizType 的 5/6 与 §13.5、落库值不一致 → 实现以 §13.5 为准(催报去重按 5);
§3.6/§9.5 的 collect_file.source 字段表(入口来源)与建表注释(谁传的)冲突 →
实现以建表口径为准。两处都写明"待客户确认",见 F-30 / F-38 / F-39。
四、check-test-profile.py 加固(新增 F-98)
· 子进程输出落盘(不再用没人读的 PIPE):失败时能看见"停在哪一行",
成功时打出启动用时(基线 ~10 秒 / 72 行 / 9.5KB);
· 开跑前按 jar + profile 清残留 JVM,且保留 dev 后端(E2E 正打着它);
· 等待期间每 15 秒报一次进度,卡住时不留沉默。
教训:随机端口这个防撞设计把残留 JVM 藏起来了 —— 撞不到端口就永远发现不了,
于是表现成"时好时坏",而失败时连日志都读不到。
验证:python scripts/verify-all.py --with-e2e → 通过 8 / 失败 0 / 跳过 0
(E2E 36 脚本 / 1548 断言 / 278s;prodguard 9/9;test profile 能起)
python scripts/verify-docs.py → 22 项全部通过
This commit is contained in:
@@ -1,10 +1,19 @@
|
||||
---
|
||||
name: project-api
|
||||
description: 在本模板项目中新增或修改 API 接口、类型定义与 vite-plugin-mock 模拟数据。涉及 getBaseApi、http、baseAPI、mock 目录、分页响应格式时使用。
|
||||
description: 在本模板项目中新增或修改 API 接口与类型定义(本仓库已不用 Mock,见开头说明)。涉及 http、baseAPI、分页响应格式、响应体适配时使用。
|
||||
---
|
||||
|
||||
# API 与 Mock
|
||||
|
||||
> ⚠️ **本仓库不用 Mock(2026-09-30 核实)**:`mock/` 目录与 `vite-plugin-mock` 都已删除,
|
||||
> `.env.development` 里 `VITE_API_PREFIX = '/api/v1'`、`VITE_API_BASE_URL = 'http://localhost:8080'`,
|
||||
> `pnpm dev` 把 `/api` 代理到真实后端 —— **后端不起着就没有数据**(这不是故障)。
|
||||
>
|
||||
> 所以本文档里所有关于 Mock 的部分(`mock/**`、`defineMock`、`getBaseApi` 生成 mock、
|
||||
> Mock 目录约定)在本仓库**不适用**,保留它们只是因为 Gi 模板升级时要做差异比对。
|
||||
> 新增接口照 `src/apis/xt/*.ts` 的写法:用 `@/utils/http`,响应体 `{ code, msg, data }`
|
||||
> (适配层会补 `records`)已在 `@/utils/http` 统一处理,业务模块不要再自己解一层。
|
||||
|
||||
## 接口层结构
|
||||
|
||||
每个业务模块一个文件,例如 `src/apis/system/user.ts`:
|
||||
|
||||
@@ -39,7 +39,7 @@
|
||||
## 快速入口
|
||||
|
||||
```bash
|
||||
pnpm dev # 开发(Mock,/mock 前缀)
|
||||
pnpm dev # 开发(/api 代理到 http://localhost:8080,没有 Mock)
|
||||
pnpm build # 生产构建
|
||||
pnpm typecheck # vue-tsc
|
||||
pnpm lint # ESLint
|
||||
@@ -47,5 +47,8 @@ pnpm lint:style # Stylelint
|
||||
```
|
||||
|
||||
- 路径别名:`@` → `src/`,`~` → 项目根目录
|
||||
- 开发默认 Mock;联调真实后端见 `vite.config.ts` 与 `.env`
|
||||
- **开发没有 Mock**:`mock/` 目录与 `vite-plugin-mock` 都已删除,`pnpm dev` 把 `/api`
|
||||
代理到 `http://localhost:8080`(见 `vite.config.ts` 的 `server.proxy` 与
|
||||
`.env.development` 的 `VITE_API_BASE_URL`)→ **后端不起着就没有数据**。
|
||||
我们的接口模块在 `src/apis/xt/`(`apis/system|user|…` 是 Gi 模板自带的)
|
||||
- 登录演示账号见 `README.md`(如 admin / 123456)
|
||||
|
||||
Reference in New Issue
Block a user