Files
admin-vue3/docs/管理后台接口设计文档.md

32 lines
759 B
Markdown
Raw Normal View History

# 管理后台接口设计文档
## 约定
- BaseURL: /api
- 认证Bearer TokenAuthorization: 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 服务器异常