docs: bootstrap canonical current truth portal (00-START-HERE through 08-NEXT-ACTIONS)
18 KiB
18 KiB
04 - 系统全量 API 接口总账 (API Inventory)
审计基准:扫描
RuoYi-Vue/ruoyi-admin/src/main/java/com/ruoyi/web/controller下全部 Spring MVC 控制器。 数据源规范 (SOURCE):必须且只能归为以下四类之一:
RAILWAYSYSTEM_INTERNAL:本系统内部业务与系统基础 API;CLIENT_PROVIDED:甲方或外部单位正式提供的真实运行 API;THIRD_PARTY:通用第三方公有服务接口;MOCK:本地自建的模拟桩接口。
1. 核心培训业务 API 账本 (TRAIN_BUSINESS)
| 接口路径 (API) | 请求方式 (METHOD) | 数据来源 (SOURCE) | 所属模块 (MODULE) | 实现状态 | 承载控制器 (CONTROLLER) | 关联数据库表 (TABLE) | 前端UI调用 (USED_BY_UI) |
|---|---|---|---|---|---|---|---|
/train/teacher/list |
GET |
RAILWAYSYSTEM_INTERNAL |
师资管理 | IMPLEMENTED |
TrainTeacherController |
train_teacher |
YES |
/train/teacher/{tId} |
GET |
RAILWAYSYSTEM_INTERNAL |
师资管理 | IMPLEMENTED |
TrainTeacherController |
train_teacher |
YES |
/train/teacher |
POST |
RAILWAYSYSTEM_INTERNAL |
师资管理 | IMPLEMENTED |
TrainTeacherController |
train_teacher |
YES |
/train/teacher |
PUT |
RAILWAYSYSTEM_INTERNAL |
师资管理 | IMPLEMENTED |
TrainTeacherController |
train_teacher |
YES |
/train/teacher/{tIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
师资管理 | IMPLEMENTED |
TrainTeacherController |
train_teacher |
YES |
/train/teacher/export |
POST |
RAILWAYSYSTEM_INTERNAL |
师资管理 | IMPLEMENTED |
TrainTeacherController |
train_teacher |
YES |
/train/me/teacher/plans |
GET |
RAILWAYSYSTEM_INTERNAL |
教师工作台 | IMPLEMENTED |
TrainTeacherMeController |
train_plan |
YES |
/train/me/teacher |
GET |
RAILWAYSYSTEM_INTERNAL |
教师工作台 | IMPLEMENTED |
TrainTeacherMeController |
train_lesson |
YES |
/train/me/teacher/students |
GET |
RAILWAYSYSTEM_INTERNAL |
教师工作台 | IMPLEMENTED |
TrainTeacherMeController |
train_enrollment |
YES |
/train/me/teacher/lessons/{lessonId}/attendance |
GET |
RAILWAYSYSTEM_INTERNAL |
教师工作台 | IMPLEMENTED |
TrainTeacherMeController |
train_student_checkin |
YES |
/train/student/list |
GET |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/student/{sId} |
GET |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/student |
POST |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/student |
PUT |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/student/{sIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/student/export |
POST |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/student/importTemplate |
GET |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/student/importData |
POST |
RAILWAYSYSTEM_INTERNAL |
学员管理 | IMPLEMENTED |
TrainStudentController |
train_student |
YES |
/train/me/student/enrollments |
GET |
RAILWAYSYSTEM_INTERNAL |
学员中心 | IMPLEMENTED |
TrainStudentMeController |
train_enrollment |
YES |
/train/me/student/timetable |
GET |
RAILWAYSYSTEM_INTERNAL |
学员中心 | IMPLEMENTED |
TrainStudentMeController |
train_lesson |
YES |
/train/me/student/report |
GET |
RAILWAYSYSTEM_INTERNAL |
学员中心 | IMPLEMENTED |
TrainStudentMeController |
train_class_report |
YES |
/train/me/student/attendance |
GET |
RAILWAYSYSTEM_INTERNAL |
学员中心 | IMPLEMENTED |
TrainStudentMeController |
train_student_checkin |
YES |
/train/me/student/duration |
GET |
RAILWAYSYSTEM_INTERNAL |
学员中心 | IMPLEMENTED |
TrainStudentMeController |
train_study_duration |
YES |
/train/me/student/portrait |
GET |
RAILWAYSYSTEM_INTERNAL |
学员中心 | IMPLEMENTED |
TrainStudentMeController |
train_student |
YES |
/train/course/list |
GET |
RAILWAYSYSTEM_INTERNAL |
课程库 | IMPLEMENTED |
TrainCourseController |
train_course |
YES |
/train/course/{cId} |
GET |
RAILWAYSYSTEM_INTERNAL |
课程库 | IMPLEMENTED |
TrainCourseController |
train_course |
YES |
/train/course |
POST |
RAILWAYSYSTEM_INTERNAL |
课程库 | IMPLEMENTED |
TrainCourseController |
train_course |
YES |
/train/course |
PUT |
RAILWAYSYSTEM_INTERNAL |
课程库 | IMPLEMENTED |
TrainCourseController |
train_course |
YES |
/train/course/{cIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
课程库 | IMPLEMENTED |
TrainCourseController |
train_course |
YES |
/train/classroom/list |
GET |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainClassroomInfoController |
train_classroom_info |
YES |
/train/classroom/{classRoomId} |
GET |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainClassroomInfoController |
train_classroom_info |
YES |
/train/classroom |
POST |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainClassroomInfoController |
train_classroom_info |
YES |
/train/classroom |
PUT |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainClassroomInfoController |
train_classroom_info |
YES |
/train/classroom/{classRoomIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainClassroomInfoController |
train_classroom_info |
YES |
/train/training-site/list |
GET |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainTrainingSiteController |
train_training_site |
YES |
/train/training-site/{siteId} |
GET |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainTrainingSiteController |
train_training_site |
YES |
/train/training-site |
POST |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainTrainingSiteController |
train_training_site |
YES |
/train/training-site |
PUT |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainTrainingSiteController |
train_training_site |
YES |
/train/training-site/{siteIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
设施管理 | IMPLEMENTED |
TrainTrainingSiteController |
train_training_site |
YES |
/train/plans |
GET |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans/{planId} |
GET |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans |
POST |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans/{planId} |
PUT |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans/{planIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans/{planId}/publish |
POST |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans/{planId}/start |
POST |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans/{planId}/complete |
POST |
RAILWAYSYSTEM_INTERNAL |
培训计划 | IMPLEMENTED |
TrainPlanController |
train_plan |
YES |
/train/plans/{planId}/courses |
GET |
RAILWAYSYSTEM_INTERNAL |
计划课程 | IMPLEMENTED |
TrainPlanCourseController |
train_plan_course |
YES |
/train/plans/{planId}/courses |
POST |
RAILWAYSYSTEM_INTERNAL |
计划课程 | IMPLEMENTED |
TrainPlanCourseController |
train_plan_course |
YES |
/train/plans/{planId}/courses/{planCourseId} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
计划课程 | IMPLEMENTED |
TrainPlanCourseController |
train_plan_course |
YES |
/train/plans/{planId}/enrollments |
GET |
RAILWAYSYSTEM_INTERNAL |
参训名单 | IMPLEMENTED |
TrainEnrollmentController |
train_enrollment |
YES |
/train/plans/{planId}/enrollments |
POST |
RAILWAYSYSTEM_INTERNAL |
参训名单 | IMPLEMENTED |
TrainEnrollmentController |
train_enrollment |
YES |
/train/plans/{planId}/enrollments/batch |
POST |
RAILWAYSYSTEM_INTERNAL |
参训名单 | IMPLEMENTED |
TrainEnrollmentController |
train_enrollment |
YES |
/train/enrollments/{enrollmentId} |
GET |
RAILWAYSYSTEM_INTERNAL |
参训名单 | IMPLEMENTED |
TrainEnrollmentController |
train_enrollment |
YES |
/train/enrollments/{enrollmentId}/status |
PUT |
RAILWAYSYSTEM_INTERNAL |
参训名单 | IMPLEMENTED |
TrainEnrollmentController |
train_enrollment |
YES |
/train/enrollments/{enrollmentId} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
参训名单 | IMPLEMENTED |
TrainEnrollmentController |
train_enrollment |
YES |
/train/plans/{planId}/lessons |
GET |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_lesson |
YES |
/train/plans/{planId}/lessons |
POST |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_lesson |
YES |
/train/lessons/{lessonId} |
GET |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_lesson |
YES |
/train/lessons/{lessonId} |
PUT |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_lesson |
YES |
/train/lessons/{lessonId} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_lesson |
YES |
/train/lessons/check-conflict |
POST |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_lesson |
YES |
/train/lessons/scheduling-options |
GET |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_classroom_info |
YES |
/train/plans/{planId}/timetable |
GET |
RAILWAYSYSTEM_INTERNAL |
排课管理 | IMPLEMENTED |
TrainLessonController |
train_lesson |
YES |
/train/enrollments/{enrollmentId}/report |
POST |
RAILWAYSYSTEM_INTERNAL |
现场报到 | IMPLEMENTED |
TrainReportActionController |
train_class_report |
YES |
/train/report/list |
GET |
RAILWAYSYSTEM_INTERNAL |
现场报到 | IMPLEMENTED |
TrainClassReportController |
train_class_report |
YES |
/train/checkin/list |
GET |
RAILWAYSYSTEM_INTERNAL |
考勤流水 | IMPLEMENTED |
TrainStudentCheckinController |
train_student_checkin |
YES |
/train/attendance/lessons/{lessonId}/checkins |
GET |
RAILWAYSYSTEM_INTERNAL |
考勤流水 | IMPLEMENTED |
AttendanceController |
train_student_checkin |
YES |
/train/attendance/proxy-checkin |
POST |
RAILWAYSYSTEM_INTERNAL |
考勤流水 | IMPLEMENTED |
AttendanceController |
train_student_checkin |
YES |
/train/attendance/mark-absent |
POST |
RAILWAYSYSTEM_INTERNAL |
考勤流水 | IMPLEMENTED |
AttendanceController |
train_student_checkin |
YES |
/train/dormitory/list |
GET |
RAILWAYSYSTEM_INTERNAL |
宿舍管理 | IMPLEMENTED |
TrainDormitoryInfoController |
train_dormitory_info |
YES |
/train/dormitory/{dormId} |
GET |
RAILWAYSYSTEM_INTERNAL |
宿舍管理 | IMPLEMENTED |
TrainDormitoryInfoController |
train_dormitory_info |
YES |
/train/dormitory |
POST |
RAILWAYSYSTEM_INTERNAL |
宿舍管理 | IMPLEMENTED |
TrainDormitoryInfoController |
train_dormitory_info |
YES |
/train/dormitory |
PUT |
RAILWAYSYSTEM_INTERNAL |
宿舍管理 | IMPLEMENTED |
TrainDormitoryInfoController |
train_dormitory_info |
YES |
/train/dormitory/{dormIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
宿舍管理 | IMPLEMENTED |
TrainDormitoryInfoController |
train_dormitory_info |
YES |
/train/accommodation/list |
GET |
RAILWAYSYSTEM_INTERNAL |
住宿安排 | IMPLEMENTED |
TrainAccommodationController |
train_accommodation |
YES |
/train/accommodation/{accommodationId} |
GET |
RAILWAYSYSTEM_INTERNAL |
住宿安排 | IMPLEMENTED |
TrainAccommodationController |
train_accommodation |
YES |
/train/accommodation |
POST |
RAILWAYSYSTEM_INTERNAL |
住宿安排 | IMPLEMENTED |
TrainAccommodationController |
train_accommodation |
YES |
/train/accommodation/check-in/{id} |
PUT |
RAILWAYSYSTEM_INTERNAL |
住宿安排 | PARTIAL (ACCOM-PERM-01) |
TrainAccommodationController |
train_accommodation |
YES |
/train/accommodation/check-out/{id} |
PUT |
RAILWAYSYSTEM_INTERNAL |
住宿安排 | PARTIAL (ACCOM-PERM-01) |
TrainAccommodationController |
train_accommodation |
YES |
/train/accommodation/transfer |
PUT |
RAILWAYSYSTEM_INTERNAL |
住宿安排 | PARTIAL (ACCOM-PERM-01) |
TrainAccommodationController |
train_accommodation |
YES |
/train/score/list |
GET |
RAILWAYSYSTEM_INTERNAL |
成绩管理 | IMPLEMENTED |
TrainScoreInfoController |
train_score_info |
YES |
/train/score/{scoreId} |
GET |
RAILWAYSYSTEM_INTERNAL |
成绩管理 | IMPLEMENTED |
TrainScoreInfoController |
train_score_info |
YES |
/train/score |
POST |
RAILWAYSYSTEM_INTERNAL |
成绩管理 | IMPLEMENTED |
TrainScoreInfoController |
train_score_info |
YES |
/train/score |
PUT |
RAILWAYSYSTEM_INTERNAL |
成绩管理 | IMPLEMENTED |
TrainScoreInfoController |
train_score_info |
YES |
/train/score/{scoreIds} |
DELETE |
RAILWAYSYSTEM_INTERNAL |
成绩管理 | IMPLEMENTED |
TrainScoreInfoController |
train_score_info |
YES |
/train/analysis/dashboard/overview |
GET |
RAILWAYSYSTEM_INTERNAL |
统计分析 | IMPLEMENTED |
TrainAnalysisController |
聚合多表 | YES |
/train/analysis/dashboard/charts |
GET |
RAILWAYSYSTEM_INTERNAL |
统计分析 | IMPLEMENTED |
TrainAnalysisController |
聚合多表 | YES |
/train/analysis/attendance/summary |
GET |
RAILWAYSYSTEM_INTERNAL |
统计分析 | IMPLEMENTED |
TrainAnalysisController |
聚合多表 | YES |
/train/analysis/attendance/charts |
GET |
RAILWAYSYSTEM_INTERNAL |
统计分析 | IMPLEMENTED |
TrainAnalysisController |
聚合多表 | YES |
/train/analysis/portrait/student-360/{studentId} |
GET |
RAILWAYSYSTEM_INTERNAL |
统计分析 | IMPLEMENTED |
TrainAnalysisController |
聚合多表 | YES |
/train/access/mapping/list |
GET |
RAILWAYSYSTEM_INTERNAL |
门禁集成 | IMPLEMENTED |
TrainAccessManagementController |
train_external_resource_mapping |
YES |
/train/access/auth/list |
GET |
RAILWAYSYSTEM_INTERNAL |
门禁集成 | IMPLEMENTED |
TrainAccessManagementController |
train_dorm_auth |
YES |
/train/access/operation/list |
GET |
RAILWAYSYSTEM_INTERNAL |
门禁集成 | IMPLEMENTED |
TrainAccessManagementController |
train_external_operation |
YES |
/train/access/capability |
GET |
RAILWAYSYSTEM_INTERNAL |
门禁集成 | IMPLEMENTED |
TrainAccessManagementController |
N/A | YES |
/train/access/issue |
POST |
RAILWAYSYSTEM_INTERNAL |
门禁集成 | BLOCKED_EXTERNAL |
TrainAccessManagementController |
train_dorm_auth |
YES |
/train/access/revoke |
POST |
RAILWAYSYSTEM_INTERNAL |
门禁集成 | BLOCKED_EXTERNAL |
TrainAccessManagementController |
train_dorm_auth |
YES |
/train/binding/teachers/bindable-users |
GET |
RAILWAYSYSTEM_INTERNAL |
身份绑定 | IMPLEMENTED |
TrainAccountBindingAdminController |
sys_user |
YES |
/train/binding/teachers/{teacherId}/bind |
POST |
RAILWAYSYSTEM_INTERNAL |
身份绑定 | IMPLEMENTED |
TrainAccountBindingAdminController |
train_teacher |
YES |
/train/binding/students/bindable-users |
GET |
RAILWAYSYSTEM_INTERNAL |
身份绑定 | IMPLEMENTED |
TrainAccountBindingAdminController |
sys_user |
YES |
/train/binding/students/{studentId}/bind |
POST |
RAILWAYSYSTEM_INTERNAL |
身份绑定 | IMPLEMENTED |
TrainAccountBindingAdminController |
train_student |
YES |
2. 系统核心底座 API (SYSTEM)
| 接口路径 (API) | 请求方式 (METHOD) | 数据来源 (SOURCE) | 所属模块 (MODULE) | 实现状态 | 承载控制器 (CONTROLLER) | 关联数据库表 (TABLE) | 前端UI调用 (USED_BY_UI) |
|---|---|---|---|---|---|---|---|
/login |
POST |
RAILWAYSYSTEM_INTERNAL |
鉴权认证 | IMPLEMENTED |
SysLoginController |
sys_user |
YES |
/logout |
POST |
RAILWAYSYSTEM_INTERNAL |
鉴权认证 | IMPLEMENTED |
SysLoginController |
Redis | YES |
/captchaImage |
GET |
RAILWAYSYSTEM_INTERNAL |
鉴权认证 | IMPLEMENTED |
CaptchaController |
Redis | YES |
/getInfo |
GET |
RAILWAYSYSTEM_INTERNAL |
鉴权认证 | IMPLEMENTED |
SysLoginController |
sys_user / sys_role |
YES |
/getRouters |
GET |
RAILWAYSYSTEM_INTERNAL |
权限路由 | IMPLEMENTED |
SysLoginController |
sys_menu |
YES |
/system/user/list |
GET |
RAILWAYSYSTEM_INTERNAL |
用户管理 | IMPLEMENTED |
SysUserController |
sys_user |
YES |
/system/role/list |
GET |
RAILWAYSYSTEM_INTERNAL |
角色管理 | IMPLEMENTED |
SysRoleController |
sys_role |
YES |
/system/menu/list |
GET |
RAILWAYSYSTEM_INTERNAL |
菜单管理 | IMPLEMENTED |
SysMenuController |
sys_menu |
YES |
/system/dict/data/type/{dictType} |
GET |
RAILWAYSYSTEM_INTERNAL |
字典管理 | IMPLEMENTED |
SysDictDataController |
sys_dict_data |
YES |