web-apis\types

2025-10-16 10:31:32 +08:00
parent aace132108
commit 6858899c4c
21 changed files with 2198 additions and 192 deletions
--- a/schoolNewsWeb/src/apis/study/index.ts
+++ b/schoolNewsWeb/src/apis/study/index.ts
@@ -0,0 +1,333 @@
+/**
+ * @description 学习相关API
+ * @author system
+ * @since 2025-10-15
+ */
+
+import { api } from '@/apis/index';
+import type { 
+  Course, 
+  CourseChapter, 
+  LearningTask, 
+  LearningRecord, 
+  LearningStatistics,
+  LearningProgress,
+  LearningRecordStatistics,
+  ResultDomain
+} from '@/types';
+
+/**
+ * 课程API服务
+ */
+export const courseApi = {
+  /**
+   * 获取课程列表
+   * @param filter 过滤条件
+   * @returns Promise<ResultDomain<Course>>
+   */
+  async getCourseList(filter?: Partial<Course>): Promise<ResultDomain<Course>> {
+    const response = await api.get<Course>('/study/course/list', filter);
+    return response.data;
+  },
+
+  /**
+   * 根据ID获取课程详情
+   * @param courseID 课程ID
+   * @returns Promise<ResultDomain<Course>>
+   */
+  async getCourseById(courseID: string): Promise<ResultDomain<Course>> {
+    const response = await api.get<Course>(`/study/course/${courseID}`);
+    return response.data;
+  },
+
+  /**
+   * 创建课程
+   * @param course 课程数据
+   * @returns Promise<ResultDomain<Course>>
+   */
+  async createCourse(course: Course): Promise<ResultDomain<Course>> {
+    const response = await api.post<Course>('/study/course/create', course);
+    return response.data;
+  },
+
+  /**
+   * 更新课程
+   * @param course 课程数据
+   * @returns Promise<ResultDomain<Course>>
+   */
+  async updateCourse(course: Course): Promise<ResultDomain<Course>> {
+    const response = await api.put<Course>('/study/course/update', course);
+    return response.data;
+  },
+
+  /**
+   * 删除课程
+   * @param courseID 课程ID
+   * @returns Promise<ResultDomain<boolean>>
+   */
+  async deleteCourse(courseID: string): Promise<ResultDomain<boolean>> {
+    const response = await api.delete<boolean>(`/study/course/${courseID}`);
+    return response.data;
+  },
+
+  /**
+   * 更新课程状态
+   * @param courseID 课程ID
+   * @param status 状态
+   * @returns Promise<ResultDomain<Course>>
+   */
+  async updateCourseStatus(courseID: string, status: number): Promise<ResultDomain<Course>> {
+    const response = await api.put<Course>(`/study/course/${courseID}/status`, null, {
+      params: { status }
+    });
+    return response.data;
+  },
+
+  /**
+   * 增加课程浏览次数
+   * @param courseID 课程ID
+   * @returns Promise<ResultDomain<Course>>
+   */
+  async incrementViewCount(courseID: string): Promise<ResultDomain<Course>> {
+    const response = await api.post<Course>(`/study/course/${courseID}/view`);
+    return response.data;
+  },
+
+  /**
+   * 增加课程学习人数
+   * @param courseID 课程ID
+   * @returns Promise<ResultDomain<Course>>
+   */
+  async incrementLearnCount(courseID: string): Promise<ResultDomain<Course>> {
+    const response = await api.post<Course>(`/study/course/${courseID}/learn`);
+    return response.data;
+  },
+
+  /**
+   * 获取课程章节列表
+   * @param courseID 课程ID
+   * @returns Promise<ResultDomain<CourseChapter>>
+   */
+  async getCourseChapters(courseID: string): Promise<ResultDomain<CourseChapter>> {
+    const response = await api.get<CourseChapter>(`/study/course/${courseID}/chapters`);
+    return response.data;
+  },
+
+  /**
+   * 根据ID获取章节详情
+   * @param chapterID 章节ID
+   * @returns Promise<ResultDomain<CourseChapter>>
+   */
+  async getChapterById(chapterID: string): Promise<ResultDomain<CourseChapter>> {
+    const response = await api.get<CourseChapter>(`/study/course/chapter/${chapterID}`);
+    return response.data;
+  },
+
+  /**
+   * 创建课程章节
+   * @param chapter 章节数据
+   * @returns Promise<ResultDomain<CourseChapter>>
+   */
+  async createChapter(chapter: CourseChapter): Promise<ResultDomain<CourseChapter>> {
+    const response = await api.post<CourseChapter>('/study/course/chapter/create', chapter);
+    return response.data;
+  },
+
+  /**
+   * 更新课程章节
+   * @param chapter 章节数据
+   * @returns Promise<ResultDomain<CourseChapter>>
+   */
+  async updateChapter(chapter: CourseChapter): Promise<ResultDomain<CourseChapter>> {
+    const response = await api.put<CourseChapter>('/study/course/chapter/update', chapter);
+    return response.data;
+  },
+
+  /**
+   * 删除课程章节
+   * @param chapterID 章节ID
+   * @returns Promise<ResultDomain<boolean>>
+   */
+  async deleteChapter(chapterID: string): Promise<ResultDomain<boolean>> {
+    const response = await api.delete<boolean>(`/study/course/chapter/${chapterID}`);
+    return response.data;
+  },
+
+  /**
+   * 更新章节排序
+   * @param chapterID 章节ID
+   * @param orderNum 排序号
+   * @returns Promise<ResultDomain<CourseChapter>>
+   */
+  async updateChapterOrder(chapterID: string, orderNum: number): Promise<ResultDomain<CourseChapter>> {
+    const response = await api.put<CourseChapter>(`/study/course/chapter/${chapterID}/order`, null, {
+      params: { orderNum }
+    });
+    return response.data;
+  }
+};
+
+/**
+ * 学习任务API服务
+ */
+export const learningTaskApi = {
+  /**
+   * 获取学习任务列表
+   * @param filter 过滤条件
+   * @returns Promise<ResultDomain<LearningTask>>
+   */
+  async getTaskList(filter?: Partial<LearningTask>): Promise<ResultDomain<LearningTask>> {
+    const response = await api.get<LearningTask>('/study/learning-task/list', filter);
+    return response.data;
+  },
+
+  /**
+   * 根据ID获取任务详情
+   * @param taskID 任务ID
+   * @returns Promise<ResultDomain<LearningTask>>
+   */
+  async getTaskById(taskID: string): Promise<ResultDomain<LearningTask>> {
+    const response = await api.get<LearningTask>(`/study/learning-task/${taskID}`);
+    return response.data;
+  },
+
+  /**
+   * 创建学习任务
+   * @param task 任务数据
+   * @returns Promise<ResultDomain<LearningTask>>
+   */
+  async createTask(task: LearningTask): Promise<ResultDomain<LearningTask>> {
+    const response = await api.post<LearningTask>('/study/learning-task/create', task);
+    return response.data;
+  },
+
+  /**
+   * 更新学习任务
+   * @param task 任务数据
+   * @returns Promise<ResultDomain<LearningTask>>
+   */
+  async updateTask(task: LearningTask): Promise<ResultDomain<LearningTask>> {
+    const response = await api.put<LearningTask>('/study/learning-task/update', task);
+    return response.data;
+  },
+
+  /**
+   * 删除学习任务
+   * @param taskID 任务ID
+   * @returns Promise<ResultDomain<boolean>>
+   */
+  async deleteTask(taskID: string): Promise<ResultDomain<boolean>> {
+    const response = await api.delete<boolean>(`/study/learning-task/${taskID}`);
+    return response.data;
+  },
+
+  /**
+   * 发布学习任务
+   * @param taskID 任务ID
+   * @returns Promise<ResultDomain<LearningTask>>
+   */
+  async publishTask(taskID: string): Promise<ResultDomain<LearningTask>> {
+    const response = await api.post<LearningTask>(`/study/learning-task/${taskID}/publish`);
+    return response.data;
+  },
+
+  /**
+   * 获取用户任务进度
+   * @param userID 用户ID
+   * @param taskID 任务ID
+   * @returns Promise<ResultDomain<LearningProgress>>
+   */
+  async getUserTaskProgress(userID: string, taskID: string): Promise<ResultDomain<LearningProgress>> {
+    const response = await api.get<LearningProgress>(`/study/learning-task/${taskID}/progress`, {
+      userID
+    });
+    return response.data;
+  }
+};
+
+/**
+ * 学习记录API服务
+ */
+export const learningRecordApi = {
+  /**
+   * 获取学习记录列表
+   * @param filter 过滤条件
+   * @returns Promise<ResultDomain<LearningRecord>>
+   */
+  async getRecordList(filter?: Partial<LearningRecord>): Promise<ResultDomain<LearningRecord>> {
+    const response = await api.get<LearningRecord>('/study/learning-record/list', filter);
+    return response.data;
+  },
+
+  /**
+   * 创建学习记录
+   * @param record 记录数据
+   * @returns Promise<ResultDomain<LearningRecord>>
+   */
+  async createRecord(record: LearningRecord): Promise<ResultDomain<LearningRecord>> {
+    const response = await api.post<LearningRecord>('/study/learning-record/create', record);
+    return response.data;
+  },
+
+  /**
+   * 更新学习记录
+   * @param record 记录数据
+   * @returns Promise<ResultDomain<LearningRecord>>
+   */
+  async updateRecord(record: LearningRecord): Promise<ResultDomain<LearningRecord>> {
+    const response = await api.put<LearningRecord>('/study/learning-record/update', record);
+    return response.data;
+  },
+
+  /**
+   * 获取用户学习统计
+   * @param userID 用户ID
+   * @param timeRange 时间范围
+   * @returns Promise<ResultDomain<LearningRecordStatistics>>
+   */
+  async getUserLearningStatistics(userID: string, timeRange?: string): Promise<ResultDomain<LearningRecordStatistics>> {
+    const response = await api.get<LearningRecordStatistics>('/study/learning-record/statistics', {
+      userID,
+      timeRange
+    });
+    return response.data;
+  },
+
+  /**
+   * 获取学习时长图表数据
+   * @param userID 用户ID
+   * @param timeRange 时间范围
+   * @returns Promise<ResultDomain<LearningRecordStatistics>>
+   */
+  async getLearningDurationChart(userID: string, timeRange?: string): Promise<ResultDomain<LearningRecordStatistics>> {
+    const response = await api.get<LearningRecordStatistics>('/study/learning-record/duration-chart', {
+      userID,
+      timeRange
+    });
+    return response.data;
+  }
+};
+
+/**
+ * 学习计划API服务
+ */
+export const learningPlanApi = {
+  /**
+   * 获取学习计划列表
+   * @returns Promise<ResultDomain<LearningTask>>
+   */
+  async getPlanList(): Promise<ResultDomain<LearningTask>> {
+    const response = await api.get<LearningTask>('/study/learning-plan/list');
+    return response.data;
+  },
+
+  /**
+   * 根据ID获取计划详情
+   * @param planID 计划ID
+   * @returns Promise<ResultDomain<LearningTask>>
+   */
+  async getPlanById(planID: string): Promise<ResultDomain<LearningTask>> {
+    const response = await api.get<LearningTask>(`/study/learning-plan/${planID}`);
+    return response.data;
+  }
+};