blp/railwaysystem
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

文档修正：更新导航与迁移后引用

Browse Source
This commit is contained in:
wangzhibiao committed 2026-09-17 16:53:03 +08:00
1 parent f7db7b592c
commit dd2082cc39
18 files changed
+160 -148
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api-v2/00_readme.md
+15 -15
View File
@@ -1,8 +1,8 @@
# RailwaySystem Phase 2：API Contract / DTO-VO / Service Boundary Design
> **阶段状态：** Phase 2 契约设计冻结稿 (Review Round 1 修订版)
> **业务最高基线：** `doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md`
> **数据持久化基线：** `doc/RailwaySystem 数据库 V2 字段设计与 Kingbase DDL 规范 V1.0.md` (21张表)
> **业务最高基线：** [一期 PRD V1.0](../requirements/一期PRD-V1.0.md)
> **数据持久化基线：** [`RailwaySystem 数据库 V2 字段设计与 Kingbase DDL 规范 V1.0.md`](../archive/database-history/RailwaySystem%20数据库%20V2%20字段设计与%20Kingbase%20DDL%20规范%20V1.0.md) (21张表)
> **代码生成器基线：** `generator-v2-ready-20260914` (只读验证通过)
> **审查基线：** `docs/api-v2/12_contract_review_round1.md` (Review Round 1 判定通过: A)
> **设计原则：** 业务工作台驱动 / 业务流程闭环驱动，坚决抵制 21 张表单表 CRUD 堆砌。
@@ -89,19 +89,19 @@ flowchart LR
| 序号 | 文档名称 | 核心内容 |
|:---|:---|:---|
| 00 | [`00_readme.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/00_readme.md) | 阶段总纲、架构全景、领域标识映射、最小合约视图与文档索引 |
| 01 | [`01_api_design_principles.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/01_api_design_principles.md) | API 架构原则、Resource vs Command、分页规范、返回包装与确定性/优先级定义 |
| 02 | [`02_module_a_base_resource_api.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/02_module_a_base_resource_api.md) | Module A 基础主数据 API 契约（教师、学员、课程、资源、教室、场地、班牌、宿舍） |
| 03 | [`03_module_b_plan_enrollment_schedule_api.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/03_module_b_plan_enrollment_schedule_api.md) | Module B 核心业务 API 契约（计划、工作台、本期课程、参训名单、排课冲突预检、课表、报到） |
| 04 | [`04_module_c_accommodation_attendance_api.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/04_module_c_accommodation_attendance_api.md) | Module C 过程执行 API 契约（宿舍预分配、调整、门禁同步、班牌签到/签退、考勤修正） |
| 05 | [`05_module_d_score_learning_statistics_api.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/05_module_d_score_learning_statistics_api.md) | Module D 业务成效 API 契约（成绩配置、打分台账、学习记录接入、统计下钻、学员画像） |
| 06 | [`06_dto_vo_catalog.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/06_dto_vo_catalog.md) | DTO / VO 领域模型资产全集（明确字段、类型、校验规则与用例映射） |
| 07 | [`07_service_boundary.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/07_service_boundary.md) | 业务编排 Application Service 与基础 CRUD Service 的职责与协作边界 |
| 08 | [`08_transaction_and_invariants.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/08_transaction_and_invariants.md) | 事务控制边界、并发锁策略与 5 大跨表业务不变量 + 1 项报到生命周期策略落地规范 |
| 09 | [`09_external_adapter_contract.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/09_external_adapter_contract.md) | 外部适配器契约（班牌/人脸考勤、智能门禁、VR/3D学习接入，Mock与轻量异步机制） |
| 10 | [`10_permission_and_error_codes.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/10_permission_and_error_codes.md) | RuoYi RBAC 权限字符定义与全业务错误码模型规范 |
| 11 | [`11_open_questions.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/11_open_questions.md) | PRD V-01 ~ V-14 现场验证问题映射、API 影响与隔离应对策略 |
| 12 | [`12_contract_review_round1.md`](file:///Users/wzb/Desktop/%E9%A1%B9%E7%9B%AE/RailwaySystem/docs/api-v2/12_contract_review_round1.md) | Contract Review Round 1 审查报告（越界修正、P0/P1/P2裁定、结论A） |
| 00 | [`00_readme.md`](00_readme.md) | 阶段总纲、架构全景、领域标识映射、最小合约视图与文档索引 |
| 01 | [`01_api_design_principles.md`](01_api_design_principles.md) | API 架构原则、Resource vs Command、分页规范、返回包装与确定性/优先级定义 |
| 02 | [`02_module_a_base_resource_api.md`](02_module_a_base_resource_api.md) | Module A 基础主数据 API 契约（教师、学员、课程、资源、教室、场地、班牌、宿舍） |
| 03 | [`03_module_b_plan_enrollment_schedule_api.md`](03_module_b_plan_enrollment_schedule_api.md) | Module B 核心业务 API 契约（计划、工作台、本期课程、参训名单、排课冲突预检、课表、报到） |
| 04 | [`04_module_c_accommodation_attendance_api.md`](04_module_c_accommodation_attendance_api.md) | Module C 过程执行 API 契约（宿舍预分配、调整、门禁同步、班牌签到/签退、考勤修正） |
| 05 | [`05_module_d_score_learning_statistics_api.md`](05_module_d_score_learning_statistics_api.md) | Module D 业务成效 API 契约（成绩配置、打分台账、学习记录接入、统计下钻、学员画像） |
| 06 | [`06_dto_vo_catalog.md`](06_dto_vo_catalog.md) | DTO / VO 领域模型资产全集（明确字段、类型、校验规则与用例映射） |
| 07 | [`07_service_boundary.md`](07_service_boundary.md) | 业务编排 Application Service 与基础 CRUD Service 的职责与协作边界 |
| 08 | [`08_transaction_and_invariants.md`](08_transaction_and_invariants.md) | 事务控制边界、并发锁策略与 5 大跨表业务不变量 + 1 项报到生命周期策略落地规范 |
| 09 | [`09_external_adapter_contract.md`](09_external_adapter_contract.md) | 外部适配器契约（班牌/人脸考勤、智能门禁、VR/3D学习接入，Mock与轻量异步机制） |
| 10 | [`10_permission_and_error_codes.md`](10_permission_and_error_codes.md) | RuoYi RBAC 权限字符定义与全业务错误码模型规范 |
| 11 | [`11_open_questions.md`](11_open_questions.md) | PRD V-01 ~ V-14 现场验证问题映射、API 影响与隔离应对策略 |
| 12 | [`12_contract_review_round1.md`](12_contract_review_round1.md) | Contract Review Round 1 审查报告（越界修正、P0/P1/P2裁定、结论A） |
---