Files
zyt/identity-admin/docs/api-contract.md
T
2026-11-11 13:53:14 +08:00

50 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 独立账号权限项目实施约定
目录:`identity-admin/`。原项目仅作为分析依据,不迁移真实账号、业务数据或私密配置。
## 技术与边界
- 后端:PHP 8.2+、ThinkPHP 8 单应用,独立 Composer 依赖。SQLite 为本地默认,MySQL 可配置;不依赖上级 `server/vendor`。
- 前端:Vue 3、TypeScript、Vite、Element Plus、Pinia、Vue Router,独立 npm 依赖。
- 范围:密码登录/退出、当前用户/修改密码、用户多角色多部门、角色授权、树形部门、目录/菜单/按钮。
- 原医疗数据范围策略、企微和 OIDC 客户端不作为独立服务前置条件;本项目是独立后台基础项目,不声称提供跨应用单点登录服务端。
- 新密码用 `password_hash`/`password_verify`,随机会话仅保存哈希;权限及停用状态每次请求重新计算。显式路由、HTTP 方法与权限映射,默认拒绝。
## HTTP 契约
前缀 `/adminapi`;JSON 请求;头 `Authorization: Bearer <token>`;响应 `{code:1,msg:"",data:...}`。失败 HTTP 400/401/403/404/409/422/429,`code:0`。
| 方法/路径 | 参数与返回 |
|---|---|
| GET `/health` | 公开,返回项目标识;不返回配置信息 |
| POST `/login/account` | `{account,password}` → `{token}` |
| POST `/login/logout` | 撤销当前会话 |
| GET `/auth.admin/mySelf` | `{id,account,name,is_root,role_id:[],dept_id:[],permissions:[],menus:[]}` |
| POST `/auth.admin/password` | `{old_password,password,password_confirm}`,撤销全部旧会话,前端重新登录 |
| GET `/auth/options` | 当前登录用户可读下拉选项,`{roles:[],depts:[],menus:[]}`;无密码与会话字段 |
| GET `/auth.admin/lists` | `page_no,page_size,keyword,disable` → `{lists:[],count,page_no,page_size}` |
| GET `/auth.role/lists` | 同上,角色列表 |
| GET `/auth.menu/lists` | 完整树数组,节点 `children:[]` |
| GET `/auth.dept/lists` | 完整树数组,节点 `children:[]` |
| POST `/auth.{admin,role,menu,dept}/{add,edit,delete}` | 新增/编辑对应字段;删除 `{id}`;返回新记录或 `{id}` |
列表行直接包含编辑需要的全部非敏感字段。
## 数据字段
- 用户:admin `id,account,name,disable(0启用/1停用),role_id:number[],dept_id:number[],role_names:string[],dept_names:string[],create_time`;创建必填 `password`,编辑密码留空不变;`password_confirm` 仅密码修改接口使用。`is_root` 不接受通过管理接口提交;保护根账号、自身停用/删除。
- 角色:`id,name,desc,sort,disable,menu_id:number[]`;提交空 `menu_id` 必须清空授权。已分配用户的角色不能直接删除。
- 菜单:`id,pid,type('M'目录/'C'页面/'A'按钮),name,paths,component,perms,icon,sort,is_show(1显示/0隐藏),disable`。页面路由为绝对路径;目录路径也可为空;按钮不作为路由;禁用父节点使其后代授权失效;禁止循环;有子节点禁止删除。页面 `perms` 对应读取权限,按钮为写操作权限。
- 部门:`id,pid,name,sort,disable`;禁止循环;有子部门或关联用户时禁止删除;停用部门禁止新增关联。
- 选项:roles 为角色平铺(含 menu_id),depts/menus 为完整树;用于编辑表单,不代替接口授权。
## 内置页面与权限
页面组件白名单:`dashboard/index`、`system/users`、`system/roles`、`system/menus`、`system/depts`。新增自定义页面可映射 `common/custom`,只展示菜单名称与说明;开发新的业务页面后再注册组件。
内置路由:`/dashboard`、`/system/users`、`/system/roles`、`/system/menus`、`/system/depts`。
权限键与原 likeadmin 风格一致:`auth.admin/lists`、`auth.admin/add`、`auth.admin/edit`、`auth.admin/delete`;role/menu/dept 同理。首页对所有登录用户可访问。超级管理员 `permissions:["*"]`;普通角色授予的有效权限取并集。菜单隐藏与禁用分开:隐藏只影响导航,禁用影响授权。
初始化脚本只在空白独立数据库中建表与创建用户,管理员密码从命令行/环境明确提供,无固定种子密码;不得自动读取上级 `.env`。