forked from xiongyuxing/tiku-backend.net
21 lines
851 B
Markdown
21 lines
851 B
Markdown
# API 契约基线
|
||
|
||
`operation-inventory.csv` 是旧 NestJS 与当前 .NET 运行时 OpenAPI 的机械比较结果。
|
||
|
||
状态说明：
|
||
|
||
- `exact_match`：HTTP 方法和路径完全一致。仍需核对 DTO、响应、权限和业务错误。
|
||
- `legacy_only`：只存在于旧 NestJS；后续决定迁移、替代或删除。
|
||
- `target_only`：只存在于 .NET；通常是新 REST 设计、诊断接口或路径调整。
|
||
|
||
重新生成：
|
||
|
||
```bash
|
||
python3 scripts/compare_openapi.py \
|
||
--legacy /path/to/nest-openapi.json \
|
||
--target /path/to/dotnet-openapi.json \
|
||
--output docs/migration/contracts/operation-inventory.csv
|
||
```
|
||
|
||
旧 NestJS 开发环境文档默认是 `/openapi.json`，当前 .NET 开发环境文档是 `/openapi/v1.json`。原始 OpenAPI 文件可能较大且会频繁变化，不提交仓库；提交归一化后的 CSV 基线。
|