ApiDocumentation.php 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054
  1. <?php
  2. namespace App\Services;
  3. /**
  4. * API 文档配置服务
  5. * 集中管理所有 API 的文档信息,包括参数说明、响应示例等
  6. */
  7. class ApiDocumentation
  8. {
  9. /**
  10. * 获取所有 API 文档
  11. */
  12. public static function all(): array
  13. {
  14. return [
  15. // ==================== 题库核心 API ====================
  16. 'api/questions' => [
  17. 'GET' => [
  18. 'summary' => '获取题目列表',
  19. 'description' => '分页获取题库中的题目,支持按知识点、难度等条件筛选',
  20. 'params' => [
  21. 'query' => [
  22. ['name' => 'page', 'type' => 'integer', 'required' => false, 'default' => '1', 'description' => '页码'],
  23. ['name' => 'per_page', 'type' => 'integer', 'required' => false, 'default' => '25', 'description' => '每页数量'],
  24. ['name' => 'kp_code', 'type' => 'string', 'required' => false, 'description' => '知识点编码,用于筛选特定知识点的题目'],
  25. ['name' => 'difficulty', 'type' => 'string', 'required' => false, 'description' => '难度等级:easy/medium/hard'],
  26. ['name' => 'search', 'type' => 'string', 'required' => false, 'description' => '搜索关键词'],
  27. ],
  28. ],
  29. 'response' => [
  30. 'success' => [
  31. 'data' => [
  32. ['id' => 1, 'content' => '计算 2+3=?', 'answer' => '5', 'difficulty' => 'easy', 'kp_code' => 'MATH_ADD_001'],
  33. ],
  34. 'meta' => [
  35. 'page' => 1,
  36. 'per_page' => 25,
  37. 'total' => 100,
  38. 'total_pages' => 4,
  39. ],
  40. ],
  41. 'error' => [
  42. 'error' => '错误信息',
  43. ],
  44. ],
  45. ],
  46. ],
  47. 'api/questions/{id}' => [
  48. 'GET' => [
  49. 'summary' => '获取单个题目详情',
  50. 'description' => '根据题目 ID 获取题目的完整信息',
  51. 'params' => [
  52. 'path' => [
  53. ['name' => 'id', 'type' => 'integer', 'required' => true, 'description' => '题目 ID'],
  54. ],
  55. ],
  56. 'response' => [
  57. 'success' => [
  58. 'id' => 1,
  59. 'content' => '计算 2+3=?',
  60. 'answer' => '5',
  61. 'analysis' => '这是一道简单的加法题...',
  62. 'difficulty' => 'easy',
  63. 'kp_code' => 'MATH_ADD_001',
  64. 'kp_name' => '整数加法',
  65. 'created_at' => '2024-01-01T00:00:00Z',
  66. ],
  67. 'error' => ['error' => 'Question not found'],
  68. ],
  69. ],
  70. 'DELETE' => [
  71. 'summary' => '删除题目',
  72. 'description' => '根据 ID 删除指定题目',
  73. 'params' => [
  74. 'path' => [
  75. ['name' => 'id', 'type' => 'integer', 'required' => true, 'description' => '题目 ID'],
  76. ],
  77. ],
  78. 'response' => [
  79. 'success' => ['success' => true, 'message' => 'Question deleted'],
  80. 'error' => ['success' => false, 'message' => 'Failed to delete'],
  81. ],
  82. ],
  83. ],
  84. 'api/questions/search' => [
  85. 'GET' => [
  86. 'summary' => '搜索题目(简单)',
  87. 'description' => '通过关键词搜索题目',
  88. 'params' => [
  89. 'query' => [
  90. ['name' => 'q', 'type' => 'string', 'required' => true, 'description' => '搜索关键词'],
  91. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '20', 'description' => '返回数量限制'],
  92. ],
  93. ],
  94. 'response' => [
  95. 'success' => [
  96. 'data' => [
  97. ['id' => 1, 'content' => '...', 'score' => 0.95],
  98. ],
  99. 'total' => 10,
  100. ],
  101. ],
  102. ],
  103. 'POST' => [
  104. 'summary' => '语义搜索题目',
  105. 'description' => '使用 AI 语义搜索匹配题目',
  106. 'params' => [
  107. 'body' => [
  108. ['name' => 'query', 'type' => 'string', 'required' => true, 'description' => '搜索查询文本'],
  109. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '20', 'description' => '返回数量限制'],
  110. ],
  111. ],
  112. 'response' => [
  113. 'success' => [
  114. 'data' => [
  115. ['id' => 1, 'content' => '...', 'similarity' => 0.92],
  116. ],
  117. ],
  118. ],
  119. ],
  120. ],
  121. 'api/questions/random' => [
  122. 'GET' => [
  123. 'summary' => '随机获取题目',
  124. 'description' => '随机获取指定数量的题目,可按条件筛选',
  125. 'params' => [
  126. 'query' => [
  127. ['name' => 'count', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '获取数量'],
  128. ['name' => 'kp_code', 'type' => 'string', 'required' => false, 'description' => '知识点编码'],
  129. ['name' => 'difficulty', 'type' => 'string', 'required' => false, 'description' => '难度等级'],
  130. ],
  131. ],
  132. 'response' => [
  133. 'success' => [
  134. 'data' => [
  135. ['id' => 5, 'content' => '...'],
  136. ],
  137. 'count' => 10,
  138. ],
  139. ],
  140. ],
  141. ],
  142. 'api/questions/statistics' => [
  143. 'GET' => [
  144. 'summary' => '获取题目统计信息',
  145. 'description' => '获取题库的统计数据,包括总数、各难度分布等',
  146. 'params' => [],
  147. 'response' => [
  148. 'success' => [
  149. 'total' => 1000,
  150. 'by_difficulty' => [
  151. 'easy' => 300,
  152. 'medium' => 500,
  153. 'hard' => 200,
  154. ],
  155. 'by_knowledge_point' => [
  156. 'MATH_ADD' => 150,
  157. 'MATH_SUB' => 120,
  158. ],
  159. ],
  160. ],
  161. ],
  162. ],
  163. 'api/questions/generate' => [
  164. 'POST' => [
  165. 'summary' => 'AI 生成题目',
  166. 'description' => '使用 AI 根据知识点和关键词生成新题目(异步任务)',
  167. 'params' => [
  168. 'body' => [
  169. ['name' => 'kp_code', 'type' => 'string', 'required' => true, 'description' => '知识点编码'],
  170. ['name' => 'keyword', 'type' => 'string', 'required' => false, 'description' => '生成关键词/提示'],
  171. ['name' => 'count', 'type' => 'integer', 'required' => false, 'default' => '5', 'description' => '生成数量'],
  172. ['name' => 'strategy', 'type' => 'string', 'required' => false, 'description' => '生成策略'],
  173. ],
  174. ],
  175. 'response' => [
  176. 'success' => [
  177. 'success' => true,
  178. 'task_id' => 'task_abc123',
  179. 'message' => 'Generation task started',
  180. ],
  181. 'error' => [
  182. 'success' => false,
  183. 'message' => '生成失败原因',
  184. ],
  185. ],
  186. ],
  187. ],
  188. 'api/questions/{id}/solution' => [
  189. 'GET' => [
  190. 'summary' => '获取题目解析',
  191. 'description' => '获取指定题目的详细解析和解题步骤',
  192. 'params' => [
  193. 'path' => [
  194. ['name' => 'id', 'type' => 'integer', 'required' => true, 'description' => '题目 ID'],
  195. ],
  196. ],
  197. 'response' => [
  198. 'success' => [
  199. 'id' => 1,
  200. 'solution' => '解题步骤...',
  201. 'key_points' => ['加法运算', '进位'],
  202. ],
  203. ],
  204. ],
  205. ],
  206. // ==================== 试卷 API ====================
  207. 'api/papers/assemble' => [
  208. 'POST' => [
  209. 'summary' => '组装试卷',
  210. 'description' => '根据题目 ID 列表组装生成试卷',
  211. 'params' => [
  212. 'body' => [
  213. ['name' => 'question_ids', 'type' => 'array', 'required' => true, 'description' => '题目 ID 数组'],
  214. ['name' => 'title', 'type' => 'string', 'required' => false, 'description' => '试卷标题'],
  215. ['name' => 'description', 'type' => 'string', 'required' => false, 'description' => '试卷描述'],
  216. ],
  217. ],
  218. 'response' => [
  219. 'success' => [
  220. 'paper_id' => 'paper_abc123',
  221. 'title' => '期中测试卷',
  222. 'question_count' => 20,
  223. 'created_at' => '2024-01-01T00:00:00Z',
  224. ],
  225. ],
  226. ],
  227. ],
  228. 'api/papers/{paperId}/json' => [
  229. 'GET' => [
  230. 'summary' => '获取试卷 JSON',
  231. 'description' => '返回与智能出卷返回值中 exam_content 完全一致的试卷 JSON,可预览或下载',
  232. 'params' => [
  233. 'path' => [
  234. ['name' => 'paperId', 'type' => 'string', 'required' => true, 'description' => '试卷 ID'],
  235. ],
  236. 'query' => [
  237. ['name' => 'download', 'type' => 'integer', 'required' => false, 'description' => '设为 1 时下载 JSON 文件'],
  238. ],
  239. ],
  240. 'response' => [
  241. 'success' => [
  242. 'paper_id' => 'paper_abc123',
  243. 'title' => '期中测试卷',
  244. 'questions' => [
  245. ['id' => 1, 'content' => '...', 'answer' => '...'],
  246. ],
  247. ],
  248. ],
  249. 'examples' => [
  250. 'GET /api/papers/paper_1765788931_ce02f6a3/json',
  251. 'GET /api/papers/paper_1765788931_ce02f6a3/json?download=1',
  252. ],
  253. ],
  254. ],
  255. // ==================== 智能出卷与学情报告 ====================
  256. 'api/intelligent-exams' => [
  257. 'POST' => [
  258. 'summary' => '智能出卷',
  259. 'description' => '根据学生情况智能生成个性化试卷,返回 PDF 和判卷地址(题量固定为系统配置,默认10题)',
  260. 'params' => [
  261. 'body' => [
  262. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID(数字)'],
  263. ['name' => 'student_name', 'type' => 'string', 'required' => true, 'description' => '学生姓名'],
  264. ['name' => 'teacher_id', 'type' => 'integer', 'required' => true, 'description' => '教师 ID(数字)'],
  265. ['name' => 'teacher_name', 'type' => 'string', 'required' => true, 'description' => '教师姓名'],
  266. ['name' => 'grade', 'type' => 'string', 'required' => true, 'description' => '年级(7/8/9)'],
  267. ['name' => 'knowledge_points', 'type' => 'array', 'required' => false, 'description' => '指定知识点列表'],
  268. ['name' => 'difficulty', 'type' => 'string', 'required' => false, 'description' => '难度偏好:easy/medium/hard/adaptive'],
  269. ],
  270. ],
  271. 'response' => [
  272. 'success' => [
  273. 'success' => true,
  274. 'task_id' => 'exam_task_abc123',
  275. 'status' => 'processing',
  276. 'message' => '试卷生成任务已提交',
  277. ],
  278. ],
  279. ],
  280. ],
  281. 'api/intelligent-exams/status/{taskId}' => [
  282. 'GET' => [
  283. 'summary' => '查询出卷任务状态',
  284. 'description' => '查询智能出卷任务的处理状态',
  285. 'params' => [
  286. 'path' => [
  287. ['name' => 'taskId', 'type' => 'string', 'required' => true, 'description' => '任务 ID'],
  288. ],
  289. ],
  290. 'response' => [
  291. 'success' => [
  292. 'task_id' => 'exam_task_abc123',
  293. 'status' => 'completed',
  294. 'pdf_url' => '/storage/exams/exam_abc123.pdf',
  295. 'exam_content' => ['...'],
  296. ],
  297. 'pending' => [
  298. 'task_id' => 'exam_task_abc123',
  299. 'status' => 'processing',
  300. 'progress' => 60,
  301. ],
  302. ],
  303. ],
  304. ],
  305. 'api/exam-analysis/report' => [
  306. 'POST' => [
  307. 'summary' => '生成学情报告',
  308. 'description' => '根据学生答题数据生成学情分析报告 PDF',
  309. 'params' => [
  310. 'body' => [
  311. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  312. ['name' => 'exam_id', 'type' => 'string', 'required' => false, 'description' => '指定考试 ID'],
  313. ['name' => 'date_range', 'type' => 'object', 'required' => false, 'description' => '日期范围 {start, end}'],
  314. ],
  315. ],
  316. 'response' => [
  317. 'success' => [
  318. 'success' => true,
  319. 'task_id' => 'report_task_abc123',
  320. 'status' => 'processing',
  321. ],
  322. ],
  323. ],
  324. ],
  325. 'api/exam-analysis/status/{taskId}' => [
  326. 'GET' => [
  327. 'summary' => '查询学情报告任务状态',
  328. 'description' => '查询学情报告生成任务的处理状态',
  329. 'params' => [
  330. 'path' => [
  331. ['name' => 'taskId', 'type' => 'string', 'required' => true, 'description' => '任务 ID'],
  332. ],
  333. ],
  334. 'response' => [
  335. 'success' => [
  336. 'task_id' => 'report_task_abc123',
  337. 'status' => 'completed',
  338. 'pdf_url' => '/storage/reports/report_abc123.pdf',
  339. ],
  340. ],
  341. ],
  342. ],
  343. // ==================== 错题本 API ====================
  344. 'api/mistake-book' => [
  345. 'GET' => [
  346. 'summary' => '获取错题列表',
  347. 'description' => '获取学生的错题记录列表,支持分页和筛选',
  348. 'params' => [
  349. 'query' => [
  350. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  351. ['name' => 'page', 'type' => 'integer', 'required' => false, 'default' => '1', 'description' => '页码'],
  352. ['name' => 'per_page', 'type' => 'integer', 'required' => false, 'default' => '20', 'description' => '每页数量'],
  353. ['name' => 'kp_code', 'type' => 'string', 'required' => false, 'description' => '按知识点筛选'],
  354. ['name' => 'error_type', 'type' => 'string', 'required' => false, 'description' => '错误类型筛选'],
  355. ['name' => 'is_favorite', 'type' => 'boolean', 'required' => false, 'description' => '只看收藏'],
  356. ],
  357. ],
  358. 'response' => [
  359. 'success' => [
  360. 'data' => [
  361. [
  362. 'id' => 1,
  363. 'question_id' => 100,
  364. 'question_content' => '...',
  365. 'student_answer' => '...',
  366. 'correct_answer' => '...',
  367. 'error_type' => 'calculation',
  368. 'is_favorite' => false,
  369. 'review_count' => 2,
  370. 'created_at' => '2024-01-01T00:00:00Z',
  371. ],
  372. ],
  373. 'meta' => ['page' => 1, 'total' => 50],
  374. ],
  375. ],
  376. ],
  377. 'POST' => [
  378. 'summary' => '新增错题',
  379. 'description' => '添加新的错题记录',
  380. 'params' => [
  381. 'body' => [
  382. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  383. ['name' => 'question_id', 'type' => 'integer', 'required' => true, 'description' => '题目 ID'],
  384. ['name' => 'student_answer', 'type' => 'string', 'required' => true, 'description' => '学生答案'],
  385. ['name' => 'error_type', 'type' => 'string', 'required' => false, 'description' => '错误类型'],
  386. ['name' => 'notes', 'type' => 'string', 'required' => false, 'description' => '备注'],
  387. ],
  388. ],
  389. 'response' => [
  390. 'success' => [
  391. 'success' => true,
  392. 'id' => 1,
  393. 'message' => '错题已添加',
  394. ],
  395. ],
  396. ],
  397. ],
  398. 'api/mistake-book/{mistakeId}' => [
  399. 'GET' => [
  400. 'summary' => '获取错题详情',
  401. 'description' => '获取单条错题的详细信息',
  402. 'params' => [
  403. 'path' => [
  404. ['name' => 'mistakeId', 'type' => 'integer', 'required' => true, 'description' => '错题记录 ID'],
  405. ],
  406. ],
  407. 'response' => [
  408. 'success' => [
  409. 'id' => 1,
  410. 'question' => ['id' => 100, 'content' => '...', 'answer' => '...'],
  411. 'student_answer' => '...',
  412. 'error_analysis' => '...',
  413. 'review_history' => [],
  414. ],
  415. ],
  416. ],
  417. ],
  418. 'api/mistake-book/{mistakeId}/favorite' => [
  419. 'POST' => [
  420. 'summary' => '收藏/取消收藏错题',
  421. 'description' => '切换错题的收藏状态',
  422. 'params' => [
  423. 'path' => [
  424. ['name' => 'mistakeId', 'type' => 'integer', 'required' => true, 'description' => '错题记录 ID'],
  425. ],
  426. ],
  427. 'response' => [
  428. 'success' => [
  429. 'success' => true,
  430. 'is_favorite' => true,
  431. ],
  432. ],
  433. ],
  434. ],
  435. 'api/mistake-book/{mistakeId}/review' => [
  436. 'POST' => [
  437. 'summary' => '标记错题已复习',
  438. 'description' => '将错题标记为已复习状态',
  439. 'params' => [
  440. 'path' => [
  441. ['name' => 'mistakeId', 'type' => 'integer', 'required' => true, 'description' => '错题记录 ID'],
  442. ],
  443. ],
  444. 'response' => [
  445. 'success' => [
  446. 'success' => true,
  447. 'review_count' => 3,
  448. 'last_review_at' => '2024-01-01T00:00:00Z',
  449. ],
  450. ],
  451. ],
  452. ],
  453. 'api/mistake-book/snapshot' => [
  454. 'GET' => [
  455. 'summary' => '获取错题本快照',
  456. 'description' => '获取错题本的统计快照数据,用于仪表板展示',
  457. 'params' => [
  458. 'query' => [
  459. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  460. ],
  461. ],
  462. 'response' => [
  463. 'success' => [
  464. 'total_mistakes' => 50,
  465. 'reviewed_count' => 30,
  466. 'favorite_count' => 10,
  467. 'by_knowledge_point' => [
  468. ['kp_code' => 'MATH_ADD', 'count' => 15],
  469. ],
  470. 'recent_mistakes' => [],
  471. ],
  472. ],
  473. ],
  474. ],
  475. 'api/mistake-book/batch-operation' => [
  476. 'POST' => [
  477. 'summary' => '错题批量操作',
  478. 'description' => '对多条错题进行批量操作',
  479. 'params' => [
  480. 'body' => [
  481. ['name' => 'mistake_ids', 'type' => 'array', 'required' => true, 'description' => '错题 ID 数组'],
  482. ['name' => 'operation', 'type' => 'string', 'required' => true, 'description' => '操作类型:mark_reviewed/mark_mastered/favorite/unfavorite'],
  483. ],
  484. ],
  485. 'response' => [
  486. 'success' => [
  487. 'success' => true,
  488. 'affected_count' => 5,
  489. ],
  490. ],
  491. ],
  492. ],
  493. // ==================== 知识点掌握 API ====================
  494. 'api/knowledge-mastery/stats/{studentId}' => [
  495. 'GET' => [
  496. 'summary' => '获取知识点掌握统计',
  497. 'description' => '获取学生各知识点的掌握情况统计数据',
  498. 'params' => [
  499. 'path' => [
  500. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  501. ],
  502. ],
  503. 'response' => [
  504. 'success' => [
  505. 'student_id' => '1764913638',
  506. 'total_knowledge_points' => 50,
  507. 'average_mastery' => 0.75,
  508. 'mastered_count' => 25,
  509. 'good_count' => 15,
  510. 'weak_count' => 10,
  511. 'details' => [
  512. ['kp_code' => 'MATH_ADD', 'kp_name' => '加法运算', 'mastery_level' => 0.85, 'mastery_change' => 0.05],
  513. ],
  514. ],
  515. ],
  516. ],
  517. ],
  518. 'api/knowledge-mastery/summary/{studentId}' => [
  519. 'GET' => [
  520. 'summary' => '获取知识点掌握摘要',
  521. 'description' => '获取学生知识点掌握情况的简化摘要信息',
  522. 'params' => [
  523. 'path' => [
  524. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  525. ],
  526. ],
  527. 'response' => [
  528. 'success' => [
  529. 'student_id' => '1764913638',
  530. 'total' => 50,
  531. 'mastered' => 25,
  532. 'unmastered' => 25,
  533. 'mastery_rate' => 0.5,
  534. 'mastery_percentage' => '50%',
  535. ],
  536. ],
  537. ],
  538. ],
  539. 'api/knowledge-mastery/graph/{studentId}' => [
  540. 'GET' => [
  541. 'summary' => '获取知识点图谱数据',
  542. 'description' => '获取学生的知识点掌握图谱可视化数据',
  543. 'params' => [
  544. 'path' => [
  545. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  546. ],
  547. 'query' => [
  548. ['name' => 'exam_id', 'type' => 'string', 'required' => false, 'description' => '考试 ID(可选)'],
  549. ],
  550. ],
  551. 'response' => [
  552. 'success' => [
  553. 'nodes' => [
  554. ['id' => 'MATH_ADD', 'name' => '加法运算', 'mastery' => 0.85, 'category' => '计算'],
  555. ],
  556. 'edges' => [
  557. ['source' => 'MATH_ADD', 'target' => 'MATH_SUB'],
  558. ],
  559. 'statistics' => [
  560. 'total_nodes' => 50,
  561. 'total_edges' => 45,
  562. 'average_mastery' => 0.75,
  563. ],
  564. ],
  565. ],
  566. ],
  567. ],
  568. 'api/knowledge-mastery/graph/snapshots/{studentId}' => [
  569. 'GET' => [
  570. 'summary' => '获取知识点图谱快照列表',
  571. 'description' => '获取学生知识点图谱的历史快照列表',
  572. 'params' => [
  573. 'path' => [
  574. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  575. ],
  576. 'query' => [
  577. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '返回数量限制'],
  578. ],
  579. ],
  580. 'response' => [
  581. 'success' => [
  582. 'snapshots' => [
  583. [
  584. 'snapshot_id' => 'snap_001',
  585. 'overall_mastery' => 0.75,
  586. 'weak_count' => 10,
  587. 'strong_count' => 25,
  588. 'created_at' => '2024-01-01T00:00:00Z',
  589. ],
  590. ],
  591. 'total' => 5,
  592. ],
  593. ],
  594. ],
  595. ],
  596. 'api/knowledge-mastery/snapshots/{studentId}' => [
  597. 'GET' => [
  598. 'summary' => '获取知识点快照列表(简化路径)',
  599. 'description' => '获取学生知识点掌握情况的历史快照列表(简化路径)',
  600. 'params' => [
  601. 'path' => [
  602. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  603. ],
  604. 'query' => [
  605. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '返回数量限制'],
  606. ],
  607. ],
  608. 'response' => [
  609. 'success' => [
  610. 'snapshots' => [
  611. [
  612. 'snapshot_id' => 'snap_001',
  613. 'overall_mastery' => 0.75,
  614. 'weak_count' => 10,
  615. 'strong_count' => 25,
  616. 'created_at' => '2024-01-01T00:00:00Z',
  617. ],
  618. ],
  619. 'total' => 5,
  620. ],
  621. ],
  622. ],
  623. ],
  624. 'api/knowledge-mastery/snapshot/{studentId}' => [
  625. 'POST' => [
  626. 'summary' => '创建知识点掌握度快照',
  627. 'description' => '为学生当前知识点掌握情况创建快照记录',
  628. 'params' => [
  629. 'path' => [
  630. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  631. ],
  632. 'body' => [
  633. ['name' => 'snapshot_type', 'type' => 'string', 'required' => false, 'default' => 'report', 'description' => '快照类型'],
  634. ['name' => 'source_id', 'type' => 'string', 'required' => false, 'description' => '来源 ID'],
  635. ['name' => 'source_name', 'type' => 'string', 'required' => false, 'description' => '来源名称'],
  636. ['name' => 'notes', 'type' => 'string', 'required' => false, 'description' => '备注信息'],
  637. ],
  638. ],
  639. 'response' => [
  640. 'success' => [
  641. 'success' => true,
  642. 'message' => '快照创建成功',
  643. 'data' => [
  644. 'snapshot_id' => 'snap_new_001',
  645. 'student_id' => '1764913638',
  646. 'created_at' => '2024-01-01T00:00:00Z',
  647. ],
  648. ],
  649. ],
  650. ],
  651. ],
  652. // ==================== 教材 API ====================
  653. 'api/textbooks' => [
  654. 'GET' => [
  655. 'summary' => '获取教材列表',
  656. 'description' => '获取所有教材列表,按年级排序',
  657. 'params' => [],
  658. 'response' => [
  659. 'success' => [
  660. 'data' => [
  661. ['id' => 1, 'name' => '七年级上册', 'grade' => 7, 'semester' => 1],
  662. ],
  663. ],
  664. ],
  665. ],
  666. ],
  667. 'api/textbooks/{id}' => [
  668. 'GET' => [
  669. 'summary' => '获取教材详情',
  670. 'description' => '获取单个教材的详细信息',
  671. 'params' => [
  672. 'path' => [
  673. ['name' => 'id', 'type' => 'integer', 'required' => true, 'description' => '教材 ID'],
  674. ],
  675. ],
  676. 'response' => [
  677. 'success' => [
  678. 'id' => 1,
  679. 'name' => '七年级上册',
  680. 'grade' => 7,
  681. 'chapters' => [],
  682. ],
  683. ],
  684. ],
  685. ],
  686. 'api/textbooks/{id}/catalog' => [
  687. 'GET' => [
  688. 'summary' => '获取教材目录',
  689. 'description' => '获取教材的章节目录结构',
  690. 'params' => [
  691. 'path' => [
  692. ['name' => 'id', 'type' => 'integer', 'required' => true, 'description' => '教材 ID'],
  693. ],
  694. ],
  695. 'response' => [
  696. 'success' => [
  697. 'chapters' => [
  698. [
  699. 'id' => 1,
  700. 'title' => '第一章 有理数',
  701. 'sections' => [
  702. ['id' => 11, 'title' => '1.1 正数和负数'],
  703. ],
  704. ],
  705. ],
  706. ],
  707. ],
  708. ],
  709. ],
  710. // ==================== 知识点与能力 API ====================
  711. 'api/knowledge-points' => [
  712. 'GET' => [
  713. 'summary' => '获取知识点列表',
  714. 'description' => '获取所有知识点选项,用于下拉选择',
  715. 'params' => [],
  716. 'response' => [
  717. 'success' => [
  718. ['code' => 'MATH_ADD', 'name' => '加法运算'],
  719. ['code' => 'MATH_SUB', 'name' => '减法运算'],
  720. ],
  721. ],
  722. ],
  723. ],
  724. 'api/knowledge/recommend' => [
  725. 'GET' => [
  726. 'summary' => '知识点推荐',
  727. 'description' => '根据学生情况推荐需要加强的知识点',
  728. 'params' => [
  729. 'query' => [
  730. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  731. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '5', 'description' => '推荐数量'],
  732. ],
  733. ],
  734. 'response' => [
  735. 'success' => [
  736. 'recommendations' => [
  737. ['kp_code' => 'MATH_FRAC', 'kp_name' => '分数运算', 'reason' => '错题率较高', 'priority' => 1],
  738. ],
  739. ],
  740. ],
  741. ],
  742. ],
  743. 'api/abilities/evaluate' => [
  744. 'POST' => [
  745. 'summary' => '能力评估',
  746. 'description' => '评估学生的数学能力水平',
  747. 'params' => [
  748. 'body' => [
  749. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  750. ['name' => 'answers', 'type' => 'array', 'required' => true, 'description' => '答题记录数组'],
  751. ],
  752. ],
  753. 'response' => [
  754. 'success' => [
  755. 'student_id' => 1,
  756. 'abilities' => [
  757. ['name' => '计算能力', 'score' => 85],
  758. ['name' => '逻辑推理', 'score' => 78],
  759. ],
  760. 'overall_score' => 80,
  761. ],
  762. ],
  763. ],
  764. ],
  765. // ==================== MathRecSys 集成 API ====================
  766. 'api/mathrecsys/health' => [
  767. 'GET' => [
  768. 'summary' => 'MathRecSys 健康检查',
  769. 'description' => '检查 MathRecSys 服务的健康状态',
  770. 'params' => [],
  771. 'response' => [
  772. 'success' => [
  773. 'status' => 'healthy',
  774. 'service' => 'MathRecSys',
  775. 'timestamp' => '2024-01-01T00:00:00Z',
  776. ],
  777. ],
  778. ],
  779. ],
  780. 'api/mathrecsys/students/{studentId}' => [
  781. 'GET' => [
  782. 'summary' => '获取学生完整信息',
  783. 'description' => '从 MathRecSys 获取学生的完整学习信息',
  784. 'params' => [
  785. 'path' => [
  786. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  787. ],
  788. ],
  789. 'response' => [
  790. 'success' => [
  791. 'id' => 1,
  792. 'name' => '张三',
  793. 'grade' => 7,
  794. 'learning_profile' => [],
  795. ],
  796. ],
  797. ],
  798. ],
  799. 'api/mathrecsys/students/{studentId}/recommendations' => [
  800. 'GET' => [
  801. 'summary' => '获取个性化推荐',
  802. 'description' => '获取基于学生学习情况的个性化题目推荐',
  803. 'params' => [
  804. 'path' => [
  805. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  806. ],
  807. 'query' => [
  808. ['name' => 'count', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '推荐数量'],
  809. ],
  810. ],
  811. 'response' => [
  812. 'success' => [
  813. 'recommendations' => [
  814. ['question_id' => 100, 'reason' => '加强分数运算', 'priority' => 1],
  815. ],
  816. ],
  817. ],
  818. ],
  819. ],
  820. 'api/mathrecsys/students/{studentId}/trajectory' => [
  821. 'GET' => [
  822. 'summary' => '获取学习轨迹',
  823. 'description' => '获取学生的学习轨迹数据',
  824. 'params' => [
  825. 'path' => [
  826. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  827. ],
  828. ],
  829. 'response' => [
  830. 'success' => [
  831. 'trajectory' => [
  832. ['date' => '2024-01-01', 'activity' => 'practice', 'duration' => 30],
  833. ],
  834. ],
  835. ],
  836. ],
  837. ],
  838. 'api/mathrecsys/classes/{classId}/analysis' => [
  839. 'GET' => [
  840. 'summary' => '班级分析',
  841. 'description' => '获取班级整体学习分析数据',
  842. 'params' => [
  843. 'path' => [
  844. ['name' => 'classId', 'type' => 'integer', 'required' => true, 'description' => '班级 ID'],
  845. ],
  846. ],
  847. 'response' => [
  848. 'success' => [
  849. 'class_id' => 1,
  850. 'student_count' => 40,
  851. 'average_mastery' => 0.75,
  852. 'weak_points' => [],
  853. ],
  854. ],
  855. ],
  856. ],
  857. // ==================== 学生作答分析 API ====================
  858. 'api/student-answers/analyze' => [
  859. 'POST' => [
  860. 'summary' => '提交学生作答结果',
  861. 'description' => '接收外部系统发送的学生作答结果,进行AI分析并更新掌握度',
  862. 'params' => [
  863. 'body' => [
  864. ['name' => 'paper_id', 'type' => 'string', 'required' => true, 'description' => '试卷 ID'],
  865. ['name' => 'student_id', 'type' => 'string', 'required' => true, 'description' => '学生 ID'],
  866. ['name' => 'answers', 'type' => 'array', 'required' => true, 'description' => '作答结果数组'],
  867. ['name' => 'answers.*.question_id', 'type' => 'string', 'required' => true, 'description' => '题目 ID'],
  868. ['name' => 'answers.*.is_correct', 'type' => 'boolean', 'required' => true, 'description' => '是否正确'],
  869. ['name' => 'answers.*.student_answer', 'type' => 'string', 'required' => false, 'description' => '学生答案'],
  870. ['name' => 'answers.*.correct_answer', 'type' => 'string', 'required' => false, 'description' => '正确答案'],
  871. ['name' => 'answers.*.score', 'type' => 'number', 'required' => false, 'description' => '得分'],
  872. ['name' => 'answers.*.max_score', 'type' => 'number', 'required' => false, 'description' => '满分'],
  873. ['name' => 'answers.*.step_scores', 'type' => 'array', 'required' => false, 'description' => '简答题步骤得分'],
  874. ['name' => 'answers.*.knowledge_point', 'type' => 'string', 'required' => false, 'description' => '知识点编码'],
  875. ['name' => 'answer_time', 'type' => 'timestamp', 'required' => false, 'description' => '答题时间'],
  876. ['name' => 'submit_time', 'type' => 'timestamp', 'required' => false, 'description' => '提交时间'],
  877. ['name' => 'source_system', 'type' => 'string', 'required' => false, 'description' => '来源系统'],
  878. ['name' => 'callback_url', 'type' => 'url', 'required' => false, 'description' => '回调通知 URL'],
  879. ],
  880. ],
  881. 'response' => [
  882. 'success' => [
  883. 'success' => true,
  884. 'message' => '作答结果已提交,正在分析中...',
  885. 'data' => [
  886. 'task_id' => 'analysis_task_xxx',
  887. 'paper_id' => 'paper_xxx',
  888. 'student_id' => 'student_xxx',
  889. 'status' => 'processing',
  890. 'created_at' => '2024-01-01T00:00:00Z',
  891. ],
  892. ],
  893. ],
  894. ],
  895. ],
  896. 'api/student-answers/analysis/status/{taskId}' => [
  897. 'GET' => [
  898. 'summary' => '查询分析任务状态',
  899. 'description' => '查询作答分析任务的处理状态',
  900. 'params' => [
  901. 'path' => [
  902. ['name' => 'taskId', 'type' => 'string', 'required' => true, 'description' => '任务 ID'],
  903. ],
  904. ],
  905. 'response' => [
  906. 'success' => [
  907. 'task_id' => 'analysis_task_xxx',
  908. 'type' => 'analysis',
  909. 'status' => 'completed',
  910. 'progress' => 100,
  911. 'message' => '分析完成',
  912. 'answer_record_id' => 'ans_xxx',
  913. 'analysis_id' => 'analysis_xxx',
  914. 'mastery_snapshot_id' => 'snap_xxx',
  915. 'correct_count' => 15,
  916. 'wrong_count' => 5,
  917. 'overall_mastery' => 0.75,
  918. 'completed_at' => '2024-01-01T00:05:00Z',
  919. ],
  920. 'pending' => [
  921. 'task_id' => 'analysis_task_xxx',
  922. 'status' => 'processing',
  923. 'progress' => 60,
  924. 'message' => '正在更新掌握度...',
  925. ],
  926. ],
  927. ],
  928. ],
  929. 'api/student-answers/history/{studentId}' => [
  930. 'GET' => [
  931. 'summary' => '获取学生学习历史',
  932. 'description' => '获取学生的练习记录、错题记录和掌握度快照历史',
  933. 'params' => [
  934. 'path' => [
  935. ['name' => 'studentId', 'type' => 'string', 'required' => true, 'description' => '学生 ID'],
  936. ],
  937. 'query' => [
  938. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '返回记录数量限制'],
  939. ],
  940. ],
  941. 'response' => [
  942. 'success' => [
  943. 'exercises' => [
  944. [
  945. 'student_id' => 'student_xxx',
  946. 'question_id' => 'q_xxx',
  947. 'is_correct' => true,
  948. 'kp_code' => 'MATH_ADD',
  949. 'created_at' => '2024-01-01T00:00:00Z',
  950. ],
  951. ],
  952. 'mistakes' => [
  953. [
  954. 'student_id' => 'student_xxx',
  955. 'question_id' => 'q_xxx',
  956. 'error_type' => 'calculation',
  957. 'review_status' => 'pending',
  958. 'created_at' => '2024-01-01T00:00:00Z',
  959. ],
  960. ],
  961. 'mastery_snapshots' => [
  962. [
  963. 'snapshot_id' => 'snap_xxx',
  964. 'overall_mastery' => 0.75,
  965. 'weak_knowledge_points_count' => 3,
  966. 'strong_knowledge_points_count' => 7,
  967. 'snapshot_time' => '2024-01-01T00:00:00Z',
  968. ],
  969. ],
  970. 'summary' => [
  971. 'total_exercises' => 100,
  972. 'total_mistakes' => 25,
  973. 'mastery_snapshots_count' => 10,
  974. ],
  975. ],
  976. ],
  977. ],
  978. ],
  979. ];
  980. }
  981. /**
  982. * 获取指定 API 的文档
  983. */
  984. public static function get(string $uri, ?string $method = null): ?array
  985. {
  986. $docs = self::all();
  987. if (!isset($docs[$uri])) {
  988. return null;
  989. }
  990. if ($method) {
  991. return $docs[$uri][$method] ?? null;
  992. }
  993. return $docs[$uri];
  994. }
  995. /**
  996. * 获取 HTTP 方法的颜色样式
  997. */
  998. public static function getMethodColor(string $method): string
  999. {
  1000. return match (strtoupper($method)) {
  1001. 'GET' => 'bg-green-100 text-green-700 border-green-200',
  1002. 'POST' => 'bg-blue-100 text-blue-700 border-blue-200',
  1003. 'PUT' => 'bg-amber-100 text-amber-700 border-amber-200',
  1004. 'PATCH' => 'bg-purple-100 text-purple-700 border-purple-200',
  1005. 'DELETE' => 'bg-red-100 text-red-700 border-red-200',
  1006. default => 'bg-gray-100 text-gray-700 border-gray-200',
  1007. };
  1008. }
  1009. }