From 74369283284271495174fbb436cfd7d6b9e01098 Mon Sep 17 00:00:00 2001 From: huertian Date: Fri, 3 Jan 2025 16:30:25 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9API=E6=96=87=E6=A1=A3Spring?= =?UTF-8?q?=20Security=20=E7=9B=B8=E5=85=B3=E5=AD=97=E6=AE=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- API文档.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/API文档.md b/API文档.md index 154d86b..475207d 100644 --- a/API文档.md +++ b/API文档.md @@ -50,9 +50,17 @@ - 4: 系统制作方项目负责人 3. **用户状态 (status)** + - 1: 正常 - 0: 禁用 +4. **Spring Security 相关字段** + - `enabled`: 账号是否启用(true: 启用,false: 禁用) + - `accountNonExpired`: 账号是否未过期(true: 未过期,false: 已过期) + - `accountNonLocked`: 账号是否未锁定(true: 未锁定,false: 已锁定) + - `credentialsNonExpired`: 密码是否未过期(true: 未过期,false: 已过期) + - `authorities`: 用户权限列表,包含用户被授予的所有权限(如 "ROLE_USER") + ### 课程任务相关字段 1. **进度状态 (progressStatus)** @@ -326,7 +334,7 @@ - **查询参数**: - `page`: 页码(从 1 开始) - `size`: 每页数量(默认 10) - - `userId`: 用户ID(可选) + - `userId`: 用户 ID(可选) - **成功响应**: ```json { @@ -372,10 +380,10 @@ ### 2. 获取单个课程任务 - **接口**:`GET /api/lesson-tasks/{id}` -- **描述**:根据ID获取课程任务详情 +- **描述**:根据 ID 获取课程任务详情 - **认证**:需要 - **路径参数**: - - `id`: 课程任务ID + - `id`: 课程任务 ID - **成功响应**: ```json { @@ -444,7 +452,7 @@ - **描述**:更新课程任务信息 - **认证**:需要 - **路径参数**: - - `id`: 课程任务ID + - `id`: 课程任务 ID - **请求体**: ```json { @@ -482,7 +490,7 @@ - **描述**:获取指定部门的课程任务列表 - **认证**:需要 - **路径参数**: - - `departmentId`: 部门ID + - `departmentId`: 部门 ID - **查询参数**: - `page`: 页码(从 1 开始) - `size`: 每页数量(默认 10) @@ -527,7 +535,7 @@ - **描述**:删除指定的课程任务 - **认证**:需要 - **路径参数**: - - `id`: 课程任务ID + - `id`: 课程任务 ID - **成功响应**: ```json { @@ -539,7 +547,7 @@ ## 注意事项 -1. 所有时间戳字段均使用秒级时间戳(10位) +1. 所有时间戳字段均使用秒级时间戳(10 位) 2. 课程任务状态变更时会自动记录相应的时间戳 3. 部门课程任务列表会额外返回用户名信息 -4. 分页参数中的页码从1开始 +4. 分页参数中的页码从 1 开始