修改API文档Spring Security 相关字段

This commit is contained in:
huertian 2025-01-03 16:30:25 +08:00
parent 7f48021452
commit 7436928328

View File

@ -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 开始