18 lines
772 B
Markdown
18 lines
772 B
Markdown
# OpenAPI 路径维护备注
|
||
|
||
当前 `docs/api-contracts/**/openapi.yaml` 的 `paths` 键已经是完整外部路径，不需要也不应该在讲解包中描述为运行时再追加入口前缀。
|
||
|
||
已核实示例：
|
||
|
||
- `docs/api-contracts/content/openapi.yaml`
|
||
- 路径：`/app-api/muse/works`
|
||
- operationId：`listWorks`
|
||
- 当前代码事实：`AppContentController`、`ContentAppService`、`ContentAppServiceImpl`
|
||
|
||
维护规则：
|
||
|
||
1. 讲解合同路径时直接引用 OpenAPI `paths` 的完整键。
|
||
2. `app-api` 和 `admin-api` 只说明入口侧，不说明领域归属。
|
||
3. 后端完成矩阵应以 operationId、Controller、Application Service 和真实业务证据共同判断。
|
||
4. 不把仍由 catch-all 或通用持久化处理的 operation 标为完成。
|