Skip to content

API 概览

MineShop 提供 RESTful 风格的 API 接口,分为后台管理接口和前端用户接口。

🎯 接口分类

分类前缀说明
后台接口/admin管理后台使用
前端接口/api用户端使用

🔐 认证方式

JWT Token

所有接口(除登录外)需要在请求头携带 Token:

Authorization: Bearer <token>

获取 Token

bash
POST /admin/login
Content-Type: application/json

{
    "username": "admin",
    "password": "admin123"
}

响应:

json
{
    "code": 200,
    "message": "success",
    "data": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
        "expire_at": 1234567890
    }
}

📦 响应格式

成功响应

json
{
    "code": 200,
    "message": "success",
    "data": {
        // 业务数据
    }
}

分页响应

json
{
    "code": 200,
    "message": "success",
    "data": {
        "items": [...],
        "total": 100,
        "page": 1,
        "pageSize": 20
    }
}

错误响应

json
{
    "code": 400,
    "message": "参数错误",
    "data": null
}

📋 状态码

状态码说明
200成功
400参数错误
401未授权
403禁止访问
404资源不存在
500服务器错误

📚 相关文档

基于 Apache-2.0 许可发布 | 感谢 MineAdmin 提供的优秀基础框架