src/api文件夹下的注释

frontend/src/api/exam.js

@@ -2,7 +2,11 @@
 
 import api from './index'
 import { axios } from '../utils/request'
-
+/**
+ * 获取问题列表
+ * @param {Object} parameter - 请求参数
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getQuestionList (parameter) {
   return axios({
     url: api.ExamQuestionList,
@@ -10,14 +14,21 @@ export function getQuestionList (parameter) {
     params: parameter
   })
 }
-
+/**
+ * 获取所有问题
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getQuestionAll () {
   return axios({
     url: api.ExamQuestionAll,
     method: 'get'
   })
 }
-
+/**
+ * 更新问题
+ * @param {Object} parameter - 请求参数
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function questionUpdate (parameter) {
   console.log(parameter)
   return axios({
@@ -26,7 +37,10 @@ export function questionUpdate (parameter) {
     data: parameter
   })
 }
-
+/**
+ * 获取问题选择项
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getQuestionSelection () {
   return axios({
     url: api.ExamQuestionSelection,
@@ -36,7 +50,11 @@ export function getQuestionSelection () {
     }
   })
 }
-
+/**
+ * 创建问题
+ * @param {Object} parameter - 请求参数
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function questionCreate (parameter) {
   console.log(parameter)
   return axios({
@@ -45,7 +63,11 @@ export function questionCreate (parameter) {
     data: parameter
   })
 }
-
+/**
+ * 获取考试列表
+ * @param {Object} parameter - 请求参数
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getExamList (parameter) {
   return axios({
     url: api.ExamList,
@@ -53,14 +75,20 @@ export function getExamList (parameter) {
     params: parameter
   })
 }
-
+/**
+ * 获取所有考试
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getExamAll () {
   return axios({
     url: api.ExamAll,
     method: 'get'
   })
 }
-
+/**
+ * 获取所有问题，按照单选、多选和判断进行分类
+ * @returns {Promise} - 返回axios请求对象
+ */
 // 获取所有问题，按照单选、多选和判断进行分类
 export function getExamQuestionTypeList () {
   return axios({
@@ -71,7 +99,10 @@ export function getExamQuestionTypeList () {
     }
   })
 }
-
+/**
+ * 获取考试卡片列表
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getExamCardList () {
   return axios({
     url: api.ExamCardList,
@@ -81,7 +112,11 @@ export function getExamCardList () {
     }
   })
 }
-
+/**
+ * 创建考试
+ * @param {Object} parameter - 请求参数
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function examCreate (parameter) {
   console.log(parameter)
   return axios({
@@ -90,7 +125,11 @@ export function examCreate (parameter) {
     data: parameter
   })
 }
-
+/**
+ * 更新考试
+ * @param {Object} parameter - 请求参数
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function examUpdate (parameter) {
   console.log(parameter)
   return axios({
@@ -99,7 +138,11 @@ export function examUpdate (parameter) {
     data: parameter
   })
 }
-
+/**
+ * 获取考试详情
+ * @param {String} examId - 考试ID
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getExamDetail (examId) {
   return axios({
     url: api.ExamDetail + examId,
@@ -109,7 +152,11 @@ export function getExamDetail (examId) {
     }
   })
 }
-
+/**
+ * 获取考试记录详情
+ * @param {String} recordId - 记录ID
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getExamRecordDetail (recordId) {
   return axios({
     url: api.recordDetail + recordId,
@@ -119,7 +166,11 @@ export function getExamRecordDetail (recordId) {
     }
   })
 }
-
+/**
+ * 获取问题详情
+ * @param {String} questionId - 问题ID
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getQuestionDetail (questionId) {
   return axios({
     url: api.QuestionDetail + questionId,
@@ -129,7 +180,12 @@ export function getQuestionDetail (questionId) {
     }
   })
 }
-
+/**
+ * 完成考试
+ * @param {String} examId - 考试ID
+ * @param {Object} answersMap - 答案映射
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function finishExam (examId, answersMap) {
   console.log(answersMap)
   return axios({
@@ -141,7 +197,10 @@ export function finishExam (examId, answersMap) {
     data: answersMap
   })
 }
-
+/**
+ * 获取考试记录列表
+ * @returns {Promise} - 返回axios请求对象
+ */
 export function getExamRecordList () {
   return axios({
     url: api.ExamRecordList,

frontend/src/api/index.js

@@ -1,9 +1,12 @@
+// 定义一个常量对象api，用于存储各种操作的api路径
 const api = {
+  // 用户认证相关API
   Login: '/auth/login',
   Logout: '/auth/logout',
   ForgePassword: '/auth/forge-password',
   Register: '/auth/register',
   twoStepCode: '/auth/2step-code',
+  // 短信服务相关API
   SendSms: '/account/sms',
   SendSmsErr: '/account/sms_err',
   // get my info
@@ -35,4 +38,5 @@ const api = {
   ExamRecordList: '/exam/record/list',
   recordDetail: '/exam/record/detail/'
 }
+// 导出api对象，这样其他模块就可以直接引用api对象了
 export default api

frontend/src/api/login.js

@@ -1,16 +1,17 @@
+// 导入api端点配置和请求工具
 import api from './index'
 import { axios } from '../utils/request'
 
 /**
- * login func
+ * 登录功能
  * parameter: {
  *     username: '',
  *     password: '',
  *     remember_me: true,
  *     captcha: '12345'
  * }
- * @param parameter
- * @returns {*}
+ * @param parameter 包含用户名、密码、是否记住登录状态和验证码的对象
+ * @returns {*} 返回登录请求的Promise对象
  */
 export function login (parameter) {
   return axios({
@@ -21,6 +22,11 @@ export function login (parameter) {
   })
 }
 
+/**
+ * 获取短信验证码
+ * @param parameter 包含手机号等信息的对象
+ * @returns {*} 返回发送短信验证码请求的Promise对象
+ */
 export function getSmsCaptcha (parameter) {
   return axios({
     url: api.SendSms,
@@ -28,7 +34,10 @@ export function getSmsCaptcha (parameter) {
     data: parameter
   })
 }
-
+/**
+ * 获取用户信息
+ * @returns {*} 返回获取用户信息请求的Promise对象
+ */
 export function getInfo () {
   return axios({
     url: api.UserInfo,
@@ -38,7 +47,10 @@ export function getInfo () {
     }
   })
 }
-
+/**
+ * 用户登出
+ * @returns {*} 返回用户登出请求的Promise对象
+ */
 export function logout () {
   return axios({
     url: api.Logout,
@@ -49,9 +61,11 @@ export function logout () {
   })
 }
 
+
 /**
- * get user 2step code open?
- * @param parameter {*}
+ * 获取用户两步验证状态
+ * @param parameter 包含用户信息的对象
+ * @returns {*} 返回获取两步验证状态请求的Promise对象
  */
 export function get2step (parameter) {
   return axios({

frontend/src/api/user.js

@@ -2,7 +2,11 @@
 
 import api from './index'
 import { axios } from '../utils/request'
-
+/**
+ * 用户登录接口
+ * @param {Object} parameter - 登录所需的参数，如用户名和密码
+ * @returns {Promise} - 返回axios请求的Promise对象，包含登录结果
+ */
 export function login (parameter) {
   return axios({
     url: api.UserLogin,
@@ -10,7 +14,11 @@ export function login (parameter) {
     data: parameter
   })
 }
-
+/**
+ * 用户注册接口
+ * @param {Object} parameter - 注册所需的参数，如用户名、密码和邮箱等
+ * @returns {Promise} - 返回axios请求的Promise对象，包含注册结果
+ */
 export function register (parameter) {
   return axios({
     url: api.UserRegister,