API 文档

详细的API接口文档,帮助您快速集成和使用我们的服务

API 概览

基础URL

https://your-backend-domain.com/dev-api

认证方式

Bearer Token (X-Token Header)

响应格式

JSON

状态码

20000: 成功, 其他: 错误

认证说明

获取Token

通过登录接口获取访问令牌,然后在后续请求中携带该令牌。

测试账号:

  • • 管理员: username: admin, password: 任意
  • • 编辑者: username: editor, password: 任意

使用Token

在请求头中添加 X-Token 字段:

X-Token: your-token-here

API 接口

POST/vue-admin-template/user/login
用户登录

请求体

{
  "username": "string",
  "password": "string"
}

响应示例

{
  "code": 20000,
  "data": {
    "token": "string"
  }
}
GET/vue-admin-template/user/info
获取用户信息

请求参数

{
  "token": "string"
}

响应示例

{
  "code": 20000,
  "data": {
    "roles": [
      "admin"
    ],
    "introduction": "string",
    "avatar": "string",
    "name": "string"
  }
}
POST/vue-admin-template/user/logout
用户登出

响应示例

{
  "code": 20000,
  "data": "success"
}
GET/vue-admin-template/table/list
获取内容列表

响应示例

{
  "code": 20000,
  "data": {
    "total": 30,
    "items": [
      {
        "id": "string",
        "title": "string",
        "status": "published | draft | deleted",
        "author": "string",
        "display_time": "string",
        "pageviews": "number"
      }
    ]
  }
}
错误码说明
20000请求成功
50008登录失败,无法获取用户详情
60204账号或密码错误