二、API 基础结构

2.1 API 基础路径和请求方式

所有 API 接口都通过以下基础路径访问:

{域名地址}/api/接口路径

例如:https://www.anqicms.com/api/archive/list

API 支持的 HTTP 请求方式包括:

  • GET - 获取数据
  • POST - 创建数据或提交表单,更新数据、删除数据

2.2 认证方式

部分接口需要用户认证,系统采用 JWT Token 认证方式:

  • 登录后获取 Token
  • 在请求头中携带 Token
  • 格式:Token: {token}

2.3 请求和响应格式

请求格式:

  • 除文件上传外,所有接口使用 JSON 格式传输数据
  • Content-Type: application/json
  • GET 请求参数通过 URL Query 传递

响应格式:

{
  "code": 0,
  "msg": "",
  "data": {}
}

2.4 通用请求头

所有 API 接口都遵循以下通用请求头规范:

字段名 类型 说明
Content-Type string 固定值:application/json
Token string JWT 认证令牌(需要认证的接口)