API 参考
Lartrix 提供完整的 RESTful API,用于构建后台管理系统。
API 规范
基础 URL
/api/admin认证方式
使用 Laravel Sanctum 的 Token 认证:
http
Authorization: Bearer {token}响应格式
所有响应都使用统一的 JSON 格式:
json
{
"code": 200,
"message": "操作成功",
"data": { }
}错误响应:
json
{
"code": 400,
"message": "参数错误",
"data": null
}HTTP 状态码
| 状态码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 请求参数错误 |
| 401 | 未认证 |
| 403 | 无权限 |
| 404 | 资源不存在 |
| 500 | 服务器错误 |
API 分类
- 认证 API - 登录、登出、刷新 Token
- 用户管理 - 用户的增删改查
- 角色管理 - 角色的增删改查
- 权限管理 - 权限列表
- 菜单管理 - 菜单的增删改查
- 模块管理 - 模块管理
- 系统设置 - 系统配置
- 数据字典 - 字典数据
- 通知管理 - 通知消息
通用参数
分页参数
GET /users?page=1&per_page=15| 参数 | 说明 | 默认值 |
|---|---|---|
| page | 当前页码 | 1 |
| per_page | 每页数量 | 15 |
排序参数
GET /users?order_by=created_at&order=desc搜索参数
GET /users?keyword=john