API 接口文档

API 接口文档

管理员认证

方法 路径 说明
POST /api/admin/auth/login 管理员登录
POST /api/admin/auth/logout 退出登录
POST /api/admin/auth/refresh 刷新令牌
GET /api/admin/auth/profile 获取管理员信息

登录示例

curl -X POST http://localhost:8080/api/admin/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "admin123"}'

用户管理

方法 路径 说明
POST /api/admin/users 创建用户
GET /api/admin/users 用户列表
GET /api/admin/users/:id 用户详情
PUT /api/admin/users/:id 更新用户
DELETE /api/admin/users/:id 删除用户
PUT /api/admin/users/:id/status 更新状态
PUT /api/admin/users/:id/reset-password 重置密码
POST /api/admin/users/batch 批量操作
POST /api/admin/users/:id/roles/:roleId 分配角色
GET /api/admin/users/:id/roles 获取用户角色
GET /api/admin/users/:id/permissions 获取用户权限
GET /api/admin/users/:id/menu-tree 获取用户菜单树

角色管理

方法 路径 说明
POST /api/admin/roles 创建角色
GET /api/admin/roles 角色列表
GET /api/admin/roles/tree 角色树
GET/PUT/DELETE /api/admin/roles/:id 角色 CRUD
PUT /api/admin/roles/:id/status 更新状态
POST /api/admin/roles/:id/permissions 分配权限
GET /api/admin/roles/:id/permissions 获取权限
GET /api/admin/roles/stats 统计信息

权限管理

方法 路径 说明
POST /api/admin/permissions 创建权限
GET /api/admin/permissions 权限列表
GET /api/admin/permissions/tree 权限树
GET /api/admin/permissions/menu-tree 菜单树
GET/PUT/DELETE /api/admin/permissions/:id 权限 CRUD
GET /api/admin/permissions/stats 统计信息

权限类型:菜单(menu)、按钮(button)、API(api)、数据(data)

部门管理

方法 路径 说明
POST /api/admin/departments 创建部门
GET /api/admin/departments 部门列表
GET /api/admin/departments/tree 部门树
GET /api/admin/departments/roots 根部门
GET/PUT/DELETE /api/admin/departments/:id 部门 CRUD
PUT /api/admin/departments/:id/move 移动部门
GET /api/admin/departments/:id/children 子部门
GET /api/admin/departments/:id/descendants 所有后代
GET /api/admin/departments/:id/users 部门用户

应用管理

方法 路径 说明
POST /api/admin/applications 创建应用
GET /api/admin/applications 应用列表
GET/PUT/DELETE /api/admin/applications/:id 应用 CRUD
GET /api/admin/applications/:id/keys 签名密钥列表
POST /api/admin/applications/:id/keys/rotate 轮转密钥
POST /api/admin/applications/:id/secret/reset 重置客户端密钥
GET/PUT /api/admin/applications/:id/access-scope 授权范围
GET /api/admin/applications/stats 统计信息

社交登录提供商

方法 路径 说明
POST /api/admin/social-providers 创建提供商
GET /api/admin/social-providers 提供商列表
GET/PUT/DELETE /api/admin/social-providers/:id 提供商 CRUD
GET /api/admin/social-providers/stats 统计信息

系统设置

方法 路径 说明
GET /api/admin/settings 所有设置
GET/PUT/DELETE /api/admin/settings/:key 单个设置
GET/PUT /api/admin/settings/register-fields/config 注册字段配置
GET/PUT /api/admin/settings/push/config 推送服务配置
GET/PUT /api/admin/settings/captcha/bindings 验证码绑定

系统管理

方法 路径 说明
GET /api/system/reload 重载配置
GET /api/system/info 系统信息

普通用户

方法 路径 说明
POST /api/user/login 用户登录
GET/PUT /api/user/profile 用户信息
PUT /api/user/password 修改密码
POST /api/auth/logout 退出
POST /api/auth/refresh 刷新令牌

社交登录

方法 路径 说明
GET /social/providers 可用提供商
GET /social/auth/:provider 发起授权
GET /social/callback/:provider 回调处理
POST /social/bind-with-login 绑定已有账户
POST /social/register-with-social 社交注册

OIDC 协议端点

方法 路径 说明
GET /oidc/:client_id/.well-known/openid-configuration 发现文档
GET/POST /oidc/:client_id/authorize 授权
GET/POST /oidc/:client_id/token 令牌
GET/POST /oidc/:client_id/userinfo 用户信息
POST /oidc/:client_id/introspect 令牌内省
POST /oidc/:client_id/revoke 令牌撤销
GET /oidc/:client_id/jwks JWKS