ApiDocumentation.php 50 KB

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