32 lines
759 B
Markdown
32 lines
759 B
Markdown
|
|
# 管理后台接口设计文档
|
|||
|
|
|
|||
|
|
## 约定
|
|||
|
|
- BaseURL: /api
|
|||
|
|
- 认证:Bearer Token(Authorization: Bearer <token>)
|
|||
|
|
- 响应规范:{ code, msg, data }
|
|||
|
|
|
|||
|
|
## 接口一览(示例)
|
|||
|
|
|
|||
|
|
### 登录
|
|||
|
|
- 方法:POST /auth/login
|
|||
|
|
- 请求:{ username, password }
|
|||
|
|
- 响应:{ token, expireAt }
|
|||
|
|
|
|||
|
|
### 用户列表
|
|||
|
|
- 方法:GET /system/users
|
|||
|
|
- 查询:page, size, keyword
|
|||
|
|
- 响应:{ total, list: [ {id, username, deptName, status} ] }
|
|||
|
|
|
|||
|
|
### 创建用户
|
|||
|
|
- 方法:POST /system/users
|
|||
|
|
- 请求:{ username, password, deptId, roleIds, tenantId }
|
|||
|
|
- 响应:{ id }
|
|||
|
|
|
|||
|
|
### 角色列表
|
|||
|
|
- 方法:GET /system/roles
|
|||
|
|
|
|||
|
|
### 菜单树
|
|||
|
|
- 方法:GET /system/menus/tree
|
|||
|
|
|
|||
|
|
### 错误码
|
|||
|
|
- 400 参数错误;401 未认证;403 无权限;404 不存在;500 服务器异常
|