Skip to content

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 分类

通用参数

分页参数

GET /users?page=1&per_page=15
参数说明默认值
page当前页码1
per_page每页数量15

排序参数

GET /users?order_by=created_at&order=desc

搜索参数

GET /users?keyword=john

基于 MIT 许可发布