补充技能说明
This commit is contained in:
@@ -15,10 +15,18 @@ version: 3.0.0
|
||||
## 接口目录
|
||||
| Method | Path | Summary | Required Params | Optional Params |
|
||||
|---|---|---|---|---|
|
||||
| POST | `/api/v1/auth/login` | login | form_data (body) | - |
|
||||
| POST | `/api/v1/auth/login/simple` | login_simple | username (query), password (query) | - |
|
||||
| GET | `/api/v1/auth/me` | get_current_user_info | - | - |
|
||||
| POST | `/api/v1/auth/refresh` | refresh_token | refresh_token (query) | - |
|
||||
| POST | `/api/v1/auth/register` | register | user_data (body) | - |
|
||||
| POST | `/api/v1/auth/login` | 用户登录 | form_data (body) | - |
|
||||
| POST | `/api/v1/auth/login/simple` | 简化版登录 | username (query), password (query) | - |
|
||||
| GET | `/api/v1/auth/me` | 获取当前用户信息 | - | - |
|
||||
| POST | `/api/v1/auth/refresh` | 刷新AccessToken | refresh_token (query) | - |
|
||||
|
||||
- 覆盖方法:`GET, POST`
|
||||
|
||||
## 接口说明
|
||||
|
||||
| 接口 | 说明 |
|
||||
|---|---|
|
||||
| `POST /login` | OAuth2标准格式登录,提交form-data(username+password),返回JWT Access Token和Refresh Token |
|
||||
| `POST /login/simple` | 简化版登录,直接通过query参数传递username和password,保持向后兼容 |
|
||||
| `GET /me` | 返回当前已登录用户的详细信息(需携带Access Token) |
|
||||
| `POST /refresh` | 使用Refresh Token换取新的Access Token,延续会话 |
|
||||
|
||||
@@ -23,3 +23,14 @@ version: 3.0.0
|
||||
| POST | `/api/v1/users/{user_id}/deactivate` | 停用用户 | user_id (path) | - |
|
||||
|
||||
- 覆盖方法:`DELETE, GET, POST, PUT`
|
||||
|
||||
## 接口说明
|
||||
|
||||
| 接口 | 说明 |
|
||||
|---|---|
|
||||
| `GET /users/` | 列出系统中所有用户(管理员权限),支持分页(skip/limit) |
|
||||
| `GET /users/{user_id}` | 按用户ID查询单个用户的详细信息 |
|
||||
| `PUT /users/{user_id}` | 更新指定用户的信息(邮箱、角色、密码等),请求体为 user_update 对象 |
|
||||
| `DELETE /users/{user_id}` | 删除指定用户(软删除或硬删除) |
|
||||
| `POST /users/{user_id}/activate` | 激活指定用户账号(管理员操作) |
|
||||
| `POST /users/{user_id}/deactivate` | 停用指定用户账号(禁止登录,管理员操作) |
|
||||
|
||||
@@ -20,3 +20,11 @@ version: 3.0.0
|
||||
| GET | `/api/v1/getuserschema/` | 获取用户模式 | network (query) | - |
|
||||
|
||||
- 覆盖方法:`GET`
|
||||
|
||||
## 接口说明
|
||||
|
||||
| 接口 | 说明 |
|
||||
|---|---|
|
||||
| `GET /getallusers/` | 获取指定管网下的所有用户列表(旧版接口,返回管网级别用户信息) |
|
||||
| `GET /getuser/` | 按用户名查询指定管网下的单个用户信息 |
|
||||
| `GET /getuserschema/` | 获取用户数据模型的字段定义(Schema) |
|
||||
|
||||
Reference in New Issue
Block a user