ApiDocumentation.php 49 KB

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