ApiDocumentation.php 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051
  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 和判卷地址',
  260. 'params' => [
  261. 'body' => [
  262. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  263. ['name' => 'knowledge_points', 'type' => 'array', 'required' => false, 'description' => '指定知识点列表'],
  264. ['name' => 'difficulty', 'type' => 'string', 'required' => false, 'description' => '难度偏好:easy/medium/hard/adaptive'],
  265. ['name' => 'question_count', 'type' => 'integer', 'required' => false, 'default' => '20', 'description' => '题目数量'],
  266. ],
  267. ],
  268. 'response' => [
  269. 'success' => [
  270. 'success' => true,
  271. 'task_id' => 'exam_task_abc123',
  272. 'status' => 'processing',
  273. 'message' => '试卷生成任务已提交',
  274. ],
  275. ],
  276. ],
  277. ],
  278. 'api/intelligent-exams/status/{taskId}' => [
  279. 'GET' => [
  280. 'summary' => '查询出卷任务状态',
  281. 'description' => '查询智能出卷任务的处理状态',
  282. 'params' => [
  283. 'path' => [
  284. ['name' => 'taskId', 'type' => 'string', 'required' => true, 'description' => '任务 ID'],
  285. ],
  286. ],
  287. 'response' => [
  288. 'success' => [
  289. 'task_id' => 'exam_task_abc123',
  290. 'status' => 'completed',
  291. 'pdf_url' => '/storage/exams/exam_abc123.pdf',
  292. 'exam_content' => ['...'],
  293. ],
  294. 'pending' => [
  295. 'task_id' => 'exam_task_abc123',
  296. 'status' => 'processing',
  297. 'progress' => 60,
  298. ],
  299. ],
  300. ],
  301. ],
  302. 'api/exam-analysis/report' => [
  303. 'POST' => [
  304. 'summary' => '生成学情报告',
  305. 'description' => '根据学生答题数据生成学情分析报告 PDF',
  306. 'params' => [
  307. 'body' => [
  308. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  309. ['name' => 'exam_id', 'type' => 'string', 'required' => false, 'description' => '指定考试 ID'],
  310. ['name' => 'date_range', 'type' => 'object', 'required' => false, 'description' => '日期范围 {start, end}'],
  311. ],
  312. ],
  313. 'response' => [
  314. 'success' => [
  315. 'success' => true,
  316. 'task_id' => 'report_task_abc123',
  317. 'status' => 'processing',
  318. ],
  319. ],
  320. ],
  321. ],
  322. 'api/exam-analysis/status/{taskId}' => [
  323. 'GET' => [
  324. 'summary' => '查询学情报告任务状态',
  325. 'description' => '查询学情报告生成任务的处理状态',
  326. 'params' => [
  327. 'path' => [
  328. ['name' => 'taskId', 'type' => 'string', 'required' => true, 'description' => '任务 ID'],
  329. ],
  330. ],
  331. 'response' => [
  332. 'success' => [
  333. 'task_id' => 'report_task_abc123',
  334. 'status' => 'completed',
  335. 'pdf_url' => '/storage/reports/report_abc123.pdf',
  336. ],
  337. ],
  338. ],
  339. ],
  340. // ==================== 错题本 API ====================
  341. 'api/mistake-book' => [
  342. 'GET' => [
  343. 'summary' => '获取错题列表',
  344. 'description' => '获取学生的错题记录列表,支持分页和筛选',
  345. 'params' => [
  346. 'query' => [
  347. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  348. ['name' => 'page', 'type' => 'integer', 'required' => false, 'default' => '1', 'description' => '页码'],
  349. ['name' => 'per_page', 'type' => 'integer', 'required' => false, 'default' => '20', 'description' => '每页数量'],
  350. ['name' => 'kp_code', 'type' => 'string', 'required' => false, 'description' => '按知识点筛选'],
  351. ['name' => 'error_type', 'type' => 'string', 'required' => false, 'description' => '错误类型筛选'],
  352. ['name' => 'is_favorite', 'type' => 'boolean', 'required' => false, 'description' => '只看收藏'],
  353. ],
  354. ],
  355. 'response' => [
  356. 'success' => [
  357. 'data' => [
  358. [
  359. 'id' => 1,
  360. 'question_id' => 100,
  361. 'question_content' => '...',
  362. 'student_answer' => '...',
  363. 'correct_answer' => '...',
  364. 'error_type' => 'calculation',
  365. 'is_favorite' => false,
  366. 'review_count' => 2,
  367. 'created_at' => '2024-01-01T00:00:00Z',
  368. ],
  369. ],
  370. 'meta' => ['page' => 1, 'total' => 50],
  371. ],
  372. ],
  373. ],
  374. 'POST' => [
  375. 'summary' => '新增错题',
  376. 'description' => '添加新的错题记录',
  377. 'params' => [
  378. 'body' => [
  379. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  380. ['name' => 'question_id', 'type' => 'integer', 'required' => true, 'description' => '题目 ID'],
  381. ['name' => 'student_answer', 'type' => 'string', 'required' => true, 'description' => '学生答案'],
  382. ['name' => 'error_type', 'type' => 'string', 'required' => false, 'description' => '错误类型'],
  383. ['name' => 'notes', 'type' => 'string', 'required' => false, 'description' => '备注'],
  384. ],
  385. ],
  386. 'response' => [
  387. 'success' => [
  388. 'success' => true,
  389. 'id' => 1,
  390. 'message' => '错题已添加',
  391. ],
  392. ],
  393. ],
  394. ],
  395. 'api/mistake-book/{mistakeId}' => [
  396. 'GET' => [
  397. 'summary' => '获取错题详情',
  398. 'description' => '获取单条错题的详细信息',
  399. 'params' => [
  400. 'path' => [
  401. ['name' => 'mistakeId', 'type' => 'integer', 'required' => true, 'description' => '错题记录 ID'],
  402. ],
  403. ],
  404. 'response' => [
  405. 'success' => [
  406. 'id' => 1,
  407. 'question' => ['id' => 100, 'content' => '...', 'answer' => '...'],
  408. 'student_answer' => '...',
  409. 'error_analysis' => '...',
  410. 'review_history' => [],
  411. ],
  412. ],
  413. ],
  414. ],
  415. 'api/mistake-book/{mistakeId}/favorite' => [
  416. 'POST' => [
  417. 'summary' => '收藏/取消收藏错题',
  418. 'description' => '切换错题的收藏状态',
  419. 'params' => [
  420. 'path' => [
  421. ['name' => 'mistakeId', 'type' => 'integer', 'required' => true, 'description' => '错题记录 ID'],
  422. ],
  423. ],
  424. 'response' => [
  425. 'success' => [
  426. 'success' => true,
  427. 'is_favorite' => true,
  428. ],
  429. ],
  430. ],
  431. ],
  432. 'api/mistake-book/{mistakeId}/review' => [
  433. 'POST' => [
  434. 'summary' => '标记错题已复习',
  435. 'description' => '将错题标记为已复习状态',
  436. 'params' => [
  437. 'path' => [
  438. ['name' => 'mistakeId', 'type' => 'integer', 'required' => true, 'description' => '错题记录 ID'],
  439. ],
  440. ],
  441. 'response' => [
  442. 'success' => [
  443. 'success' => true,
  444. 'review_count' => 3,
  445. 'last_review_at' => '2024-01-01T00:00:00Z',
  446. ],
  447. ],
  448. ],
  449. ],
  450. 'api/mistake-book/snapshot' => [
  451. 'GET' => [
  452. 'summary' => '获取错题本快照',
  453. 'description' => '获取错题本的统计快照数据,用于仪表板展示',
  454. 'params' => [
  455. 'query' => [
  456. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  457. ],
  458. ],
  459. 'response' => [
  460. 'success' => [
  461. 'total_mistakes' => 50,
  462. 'reviewed_count' => 30,
  463. 'favorite_count' => 10,
  464. 'by_knowledge_point' => [
  465. ['kp_code' => 'MATH_ADD', 'count' => 15],
  466. ],
  467. 'recent_mistakes' => [],
  468. ],
  469. ],
  470. ],
  471. ],
  472. 'api/mistake-book/batch-operation' => [
  473. 'POST' => [
  474. 'summary' => '错题批量操作',
  475. 'description' => '对多条错题进行批量操作',
  476. 'params' => [
  477. 'body' => [
  478. ['name' => 'mistake_ids', 'type' => 'array', 'required' => true, 'description' => '错题 ID 数组'],
  479. ['name' => 'operation', 'type' => 'string', 'required' => true, 'description' => '操作类型:mark_reviewed/mark_mastered/favorite/unfavorite'],
  480. ],
  481. ],
  482. 'response' => [
  483. 'success' => [
  484. 'success' => true,
  485. 'affected_count' => 5,
  486. ],
  487. ],
  488. ],
  489. ],
  490. // ==================== 知识点掌握 API ====================
  491. 'api/knowledge-mastery/stats/{studentId}' => [
  492. 'GET' => [
  493. 'summary' => '获取知识点掌握统计',
  494. 'description' => '获取学生各知识点的掌握情况统计数据',
  495. 'params' => [
  496. 'path' => [
  497. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  498. ],
  499. ],
  500. 'response' => [
  501. 'success' => [
  502. 'student_id' => '1764913638',
  503. 'total_knowledge_points' => 50,
  504. 'average_mastery' => 0.75,
  505. 'mastered_count' => 25,
  506. 'good_count' => 15,
  507. 'weak_count' => 10,
  508. 'details' => [
  509. ['kp_code' => 'MATH_ADD', 'kp_name' => '加法运算', 'mastery_level' => 0.85, 'mastery_change' => 0.05],
  510. ],
  511. ],
  512. ],
  513. ],
  514. ],
  515. 'api/knowledge-mastery/summary/{studentId}' => [
  516. 'GET' => [
  517. 'summary' => '获取知识点掌握摘要',
  518. 'description' => '获取学生知识点掌握情况的简化摘要信息',
  519. 'params' => [
  520. 'path' => [
  521. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  522. ],
  523. ],
  524. 'response' => [
  525. 'success' => [
  526. 'student_id' => '1764913638',
  527. 'total' => 50,
  528. 'mastered' => 25,
  529. 'unmastered' => 25,
  530. 'mastery_rate' => 0.5,
  531. 'mastery_percentage' => '50%',
  532. ],
  533. ],
  534. ],
  535. ],
  536. 'api/knowledge-mastery/graph/{studentId}' => [
  537. 'GET' => [
  538. 'summary' => '获取知识点图谱数据',
  539. 'description' => '获取学生的知识点掌握图谱可视化数据',
  540. 'params' => [
  541. 'path' => [
  542. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  543. ],
  544. 'query' => [
  545. ['name' => 'exam_id', 'type' => 'string', 'required' => false, 'description' => '考试 ID(可选)'],
  546. ],
  547. ],
  548. 'response' => [
  549. 'success' => [
  550. 'nodes' => [
  551. ['id' => 'MATH_ADD', 'name' => '加法运算', 'mastery' => 0.85, 'category' => '计算'],
  552. ],
  553. 'edges' => [
  554. ['source' => 'MATH_ADD', 'target' => 'MATH_SUB'],
  555. ],
  556. 'statistics' => [
  557. 'total_nodes' => 50,
  558. 'total_edges' => 45,
  559. 'average_mastery' => 0.75,
  560. ],
  561. ],
  562. ],
  563. ],
  564. ],
  565. 'api/knowledge-mastery/graph/snapshots/{studentId}' => [
  566. 'GET' => [
  567. 'summary' => '获取知识点图谱快照列表',
  568. 'description' => '获取学生知识点图谱的历史快照列表',
  569. 'params' => [
  570. 'path' => [
  571. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  572. ],
  573. 'query' => [
  574. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '返回数量限制'],
  575. ],
  576. ],
  577. 'response' => [
  578. 'success' => [
  579. 'snapshots' => [
  580. [
  581. 'snapshot_id' => 'snap_001',
  582. 'overall_mastery' => 0.75,
  583. 'weak_count' => 10,
  584. 'strong_count' => 25,
  585. 'created_at' => '2024-01-01T00:00:00Z',
  586. ],
  587. ],
  588. 'total' => 5,
  589. ],
  590. ],
  591. ],
  592. ],
  593. 'api/knowledge-mastery/snapshots/{studentId}' => [
  594. 'GET' => [
  595. 'summary' => '获取知识点快照列表(简化路径)',
  596. 'description' => '获取学生知识点掌握情况的历史快照列表(简化路径)',
  597. 'params' => [
  598. 'path' => [
  599. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  600. ],
  601. 'query' => [
  602. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '返回数量限制'],
  603. ],
  604. ],
  605. 'response' => [
  606. 'success' => [
  607. 'snapshots' => [
  608. [
  609. 'snapshot_id' => 'snap_001',
  610. 'overall_mastery' => 0.75,
  611. 'weak_count' => 10,
  612. 'strong_count' => 25,
  613. 'created_at' => '2024-01-01T00:00:00Z',
  614. ],
  615. ],
  616. 'total' => 5,
  617. ],
  618. ],
  619. ],
  620. ],
  621. 'api/knowledge-mastery/snapshot/{studentId}' => [
  622. 'POST' => [
  623. 'summary' => '创建知识点掌握度快照',
  624. 'description' => '为学生当前知识点掌握情况创建快照记录',
  625. 'params' => [
  626. 'path' => [
  627. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  628. ],
  629. 'body' => [
  630. ['name' => 'snapshot_type', 'type' => 'string', 'required' => false, 'default' => 'report', 'description' => '快照类型'],
  631. ['name' => 'source_id', 'type' => 'string', 'required' => false, 'description' => '来源 ID'],
  632. ['name' => 'source_name', 'type' => 'string', 'required' => false, 'description' => '来源名称'],
  633. ['name' => 'notes', 'type' => 'string', 'required' => false, 'description' => '备注信息'],
  634. ],
  635. ],
  636. 'response' => [
  637. 'success' => [
  638. 'success' => true,
  639. 'message' => '快照创建成功',
  640. 'data' => [
  641. 'snapshot_id' => 'snap_new_001',
  642. 'student_id' => '1764913638',
  643. 'created_at' => '2024-01-01T00:00:00Z',
  644. ],
  645. ],
  646. ],
  647. ],
  648. ],
  649. // ==================== 教材 API ====================
  650. 'api/textbooks' => [
  651. 'GET' => [
  652. 'summary' => '获取教材列表',
  653. 'description' => '获取所有教材列表,按年级排序',
  654. 'params' => [],
  655. 'response' => [
  656. 'success' => [
  657. 'data' => [
  658. ['id' => 1, 'name' => '七年级上册', 'grade' => 7, 'semester' => 1],
  659. ],
  660. ],
  661. ],
  662. ],
  663. ],
  664. 'api/textbooks/{id}' => [
  665. 'GET' => [
  666. 'summary' => '获取教材详情',
  667. 'description' => '获取单个教材的详细信息',
  668. 'params' => [
  669. 'path' => [
  670. ['name' => 'id', 'type' => 'integer', 'required' => true, 'description' => '教材 ID'],
  671. ],
  672. ],
  673. 'response' => [
  674. 'success' => [
  675. 'id' => 1,
  676. 'name' => '七年级上册',
  677. 'grade' => 7,
  678. 'chapters' => [],
  679. ],
  680. ],
  681. ],
  682. ],
  683. 'api/textbooks/{id}/catalog' => [
  684. 'GET' => [
  685. 'summary' => '获取教材目录',
  686. 'description' => '获取教材的章节目录结构',
  687. 'params' => [
  688. 'path' => [
  689. ['name' => 'id', 'type' => 'integer', 'required' => true, 'description' => '教材 ID'],
  690. ],
  691. ],
  692. 'response' => [
  693. 'success' => [
  694. 'chapters' => [
  695. [
  696. 'id' => 1,
  697. 'title' => '第一章 有理数',
  698. 'sections' => [
  699. ['id' => 11, 'title' => '1.1 正数和负数'],
  700. ],
  701. ],
  702. ],
  703. ],
  704. ],
  705. ],
  706. ],
  707. // ==================== 知识点与能力 API ====================
  708. 'api/knowledge-points' => [
  709. 'GET' => [
  710. 'summary' => '获取知识点列表',
  711. 'description' => '获取所有知识点选项,用于下拉选择',
  712. 'params' => [],
  713. 'response' => [
  714. 'success' => [
  715. ['code' => 'MATH_ADD', 'name' => '加法运算'],
  716. ['code' => 'MATH_SUB', 'name' => '减法运算'],
  717. ],
  718. ],
  719. ],
  720. ],
  721. 'api/knowledge/recommend' => [
  722. 'GET' => [
  723. 'summary' => '知识点推荐',
  724. 'description' => '根据学生情况推荐需要加强的知识点',
  725. 'params' => [
  726. 'query' => [
  727. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  728. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '5', 'description' => '推荐数量'],
  729. ],
  730. ],
  731. 'response' => [
  732. 'success' => [
  733. 'recommendations' => [
  734. ['kp_code' => 'MATH_FRAC', 'kp_name' => '分数运算', 'reason' => '错题率较高', 'priority' => 1],
  735. ],
  736. ],
  737. ],
  738. ],
  739. ],
  740. 'api/abilities/evaluate' => [
  741. 'POST' => [
  742. 'summary' => '能力评估',
  743. 'description' => '评估学生的数学能力水平',
  744. 'params' => [
  745. 'body' => [
  746. ['name' => 'student_id', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  747. ['name' => 'answers', 'type' => 'array', 'required' => true, 'description' => '答题记录数组'],
  748. ],
  749. ],
  750. 'response' => [
  751. 'success' => [
  752. 'student_id' => 1,
  753. 'abilities' => [
  754. ['name' => '计算能力', 'score' => 85],
  755. ['name' => '逻辑推理', 'score' => 78],
  756. ],
  757. 'overall_score' => 80,
  758. ],
  759. ],
  760. ],
  761. ],
  762. // ==================== MathRecSys 集成 API ====================
  763. 'api/mathrecsys/health' => [
  764. 'GET' => [
  765. 'summary' => 'MathRecSys 健康检查',
  766. 'description' => '检查 MathRecSys 服务的健康状态',
  767. 'params' => [],
  768. 'response' => [
  769. 'success' => [
  770. 'status' => 'healthy',
  771. 'service' => 'MathRecSys',
  772. 'timestamp' => '2024-01-01T00:00:00Z',
  773. ],
  774. ],
  775. ],
  776. ],
  777. 'api/mathrecsys/students/{studentId}' => [
  778. 'GET' => [
  779. 'summary' => '获取学生完整信息',
  780. 'description' => '从 MathRecSys 获取学生的完整学习信息',
  781. 'params' => [
  782. 'path' => [
  783. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  784. ],
  785. ],
  786. 'response' => [
  787. 'success' => [
  788. 'id' => 1,
  789. 'name' => '张三',
  790. 'grade' => 7,
  791. 'learning_profile' => [],
  792. ],
  793. ],
  794. ],
  795. ],
  796. 'api/mathrecsys/students/{studentId}/recommendations' => [
  797. 'GET' => [
  798. 'summary' => '获取个性化推荐',
  799. 'description' => '获取基于学生学习情况的个性化题目推荐',
  800. 'params' => [
  801. 'path' => [
  802. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  803. ],
  804. 'query' => [
  805. ['name' => 'count', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '推荐数量'],
  806. ],
  807. ],
  808. 'response' => [
  809. 'success' => [
  810. 'recommendations' => [
  811. ['question_id' => 100, 'reason' => '加强分数运算', 'priority' => 1],
  812. ],
  813. ],
  814. ],
  815. ],
  816. ],
  817. 'api/mathrecsys/students/{studentId}/trajectory' => [
  818. 'GET' => [
  819. 'summary' => '获取学习轨迹',
  820. 'description' => '获取学生的学习轨迹数据',
  821. 'params' => [
  822. 'path' => [
  823. ['name' => 'studentId', 'type' => 'integer', 'required' => true, 'description' => '学生 ID'],
  824. ],
  825. ],
  826. 'response' => [
  827. 'success' => [
  828. 'trajectory' => [
  829. ['date' => '2024-01-01', 'activity' => 'practice', 'duration' => 30],
  830. ],
  831. ],
  832. ],
  833. ],
  834. ],
  835. 'api/mathrecsys/classes/{classId}/analysis' => [
  836. 'GET' => [
  837. 'summary' => '班级分析',
  838. 'description' => '获取班级整体学习分析数据',
  839. 'params' => [
  840. 'path' => [
  841. ['name' => 'classId', 'type' => 'integer', 'required' => true, 'description' => '班级 ID'],
  842. ],
  843. ],
  844. 'response' => [
  845. 'success' => [
  846. 'class_id' => 1,
  847. 'student_count' => 40,
  848. 'average_mastery' => 0.75,
  849. 'weak_points' => [],
  850. ],
  851. ],
  852. ],
  853. ],
  854. // ==================== 学生作答分析 API ====================
  855. 'api/student-answers/analyze' => [
  856. 'POST' => [
  857. 'summary' => '提交学生作答结果',
  858. 'description' => '接收外部系统发送的学生作答结果,进行AI分析并更新掌握度',
  859. 'params' => [
  860. 'body' => [
  861. ['name' => 'paper_id', 'type' => 'string', 'required' => true, 'description' => '试卷 ID'],
  862. ['name' => 'student_id', 'type' => 'string', 'required' => true, 'description' => '学生 ID'],
  863. ['name' => 'answers', 'type' => 'array', 'required' => true, 'description' => '作答结果数组'],
  864. ['name' => 'answers.*.question_id', 'type' => 'string', 'required' => true, 'description' => '题目 ID'],
  865. ['name' => 'answers.*.is_correct', 'type' => 'boolean', 'required' => true, 'description' => '是否正确'],
  866. ['name' => 'answers.*.student_answer', 'type' => 'string', 'required' => false, 'description' => '学生答案'],
  867. ['name' => 'answers.*.correct_answer', 'type' => 'string', 'required' => false, 'description' => '正确答案'],
  868. ['name' => 'answers.*.score', 'type' => 'number', 'required' => false, 'description' => '得分'],
  869. ['name' => 'answers.*.max_score', 'type' => 'number', 'required' => false, 'description' => '满分'],
  870. ['name' => 'answers.*.step_scores', 'type' => 'array', 'required' => false, 'description' => '简答题步骤得分'],
  871. ['name' => 'answers.*.knowledge_point', 'type' => 'string', 'required' => false, 'description' => '知识点编码'],
  872. ['name' => 'answer_time', 'type' => 'timestamp', 'required' => false, 'description' => '答题时间'],
  873. ['name' => 'submit_time', 'type' => 'timestamp', 'required' => false, 'description' => '提交时间'],
  874. ['name' => 'source_system', 'type' => 'string', 'required' => false, 'description' => '来源系统'],
  875. ['name' => 'callback_url', 'type' => 'url', 'required' => false, 'description' => '回调通知 URL'],
  876. ],
  877. ],
  878. 'response' => [
  879. 'success' => [
  880. 'success' => true,
  881. 'message' => '作答结果已提交,正在分析中...',
  882. 'data' => [
  883. 'task_id' => 'analysis_task_xxx',
  884. 'paper_id' => 'paper_xxx',
  885. 'student_id' => 'student_xxx',
  886. 'status' => 'processing',
  887. 'created_at' => '2024-01-01T00:00:00Z',
  888. ],
  889. ],
  890. ],
  891. ],
  892. ],
  893. 'api/student-answers/analysis/status/{taskId}' => [
  894. 'GET' => [
  895. 'summary' => '查询分析任务状态',
  896. 'description' => '查询作答分析任务的处理状态',
  897. 'params' => [
  898. 'path' => [
  899. ['name' => 'taskId', 'type' => 'string', 'required' => true, 'description' => '任务 ID'],
  900. ],
  901. ],
  902. 'response' => [
  903. 'success' => [
  904. 'task_id' => 'analysis_task_xxx',
  905. 'type' => 'analysis',
  906. 'status' => 'completed',
  907. 'progress' => 100,
  908. 'message' => '分析完成',
  909. 'answer_record_id' => 'ans_xxx',
  910. 'analysis_id' => 'analysis_xxx',
  911. 'mastery_snapshot_id' => 'snap_xxx',
  912. 'correct_count' => 15,
  913. 'wrong_count' => 5,
  914. 'overall_mastery' => 0.75,
  915. 'completed_at' => '2024-01-01T00:05:00Z',
  916. ],
  917. 'pending' => [
  918. 'task_id' => 'analysis_task_xxx',
  919. 'status' => 'processing',
  920. 'progress' => 60,
  921. 'message' => '正在更新掌握度...',
  922. ],
  923. ],
  924. ],
  925. ],
  926. 'api/student-answers/history/{studentId}' => [
  927. 'GET' => [
  928. 'summary' => '获取学生学习历史',
  929. 'description' => '获取学生的练习记录、错题记录和掌握度快照历史',
  930. 'params' => [
  931. 'path' => [
  932. ['name' => 'studentId', 'type' => 'string', 'required' => true, 'description' => '学生 ID'],
  933. ],
  934. 'query' => [
  935. ['name' => 'limit', 'type' => 'integer', 'required' => false, 'default' => '10', 'description' => '返回记录数量限制'],
  936. ],
  937. ],
  938. 'response' => [
  939. 'success' => [
  940. 'exercises' => [
  941. [
  942. 'student_id' => 'student_xxx',
  943. 'question_id' => 'q_xxx',
  944. 'is_correct' => true,
  945. 'kp_code' => 'MATH_ADD',
  946. 'created_at' => '2024-01-01T00:00:00Z',
  947. ],
  948. ],
  949. 'mistakes' => [
  950. [
  951. 'student_id' => 'student_xxx',
  952. 'question_id' => 'q_xxx',
  953. 'error_type' => 'calculation',
  954. 'review_status' => 'pending',
  955. 'created_at' => '2024-01-01T00:00:00Z',
  956. ],
  957. ],
  958. 'mastery_snapshots' => [
  959. [
  960. 'snapshot_id' => 'snap_xxx',
  961. 'overall_mastery' => 0.75,
  962. 'weak_knowledge_points_count' => 3,
  963. 'strong_knowledge_points_count' => 7,
  964. 'snapshot_time' => '2024-01-01T00:00:00Z',
  965. ],
  966. ],
  967. 'summary' => [
  968. 'total_exercises' => 100,
  969. 'total_mistakes' => 25,
  970. 'mastery_snapshots_count' => 10,
  971. ],
  972. ],
  973. ],
  974. ],
  975. ],
  976. ];
  977. }
  978. /**
  979. * 获取指定 API 的文档
  980. */
  981. public static function get(string $uri, ?string $method = null): ?array
  982. {
  983. $docs = self::all();
  984. if (!isset($docs[$uri])) {
  985. return null;
  986. }
  987. if ($method) {
  988. return $docs[$uri][$method] ?? null;
  989. }
  990. return $docs[$uri];
  991. }
  992. /**
  993. * 获取 HTTP 方法的颜色样式
  994. */
  995. public static function getMethodColor(string $method): string
  996. {
  997. return match (strtoupper($method)) {
  998. 'GET' => 'bg-green-100 text-green-700 border-green-200',
  999. 'POST' => 'bg-blue-100 text-blue-700 border-blue-200',
  1000. 'PUT' => 'bg-amber-100 text-amber-700 border-amber-200',
  1001. 'PATCH' => 'bg-purple-100 text-purple-700 border-purple-200',
  1002. 'DELETE' => 'bg-red-100 text-red-700 border-red-200',
  1003. default => 'bg-gray-100 text-gray-700 border-gray-200',
  1004. };
  1005. }
  1006. }