1.1 什么是 AnQiCMS API
AnQiCMS 是一个基于 Go 语言开发的开源内容管理系统,提供了完整的 API 接口供开发者调用。API 采用 RESTful 设计风格,支持 JSON 格式的数据交互,允许开发者通过 HTTP 请求与系统进行交互,获取、创建、更新或删除内容。
1.2 API 基础概念
- API 基础路径:
/api- 所有 API 请求都需要以该路径为前缀 - 认证方式:部分接口需要认证,使用 JWT Token 进行身份验证
- 请求格式:除上传文件外,所有接口均使用 JSON 格式传输数据
- 响应格式:统一使用 JSON 格式返回数据
1.3 第一个 API 调用示例
以获取文章列表为例,介绍一次完整的 API 调用流程:
GET /api/archive/list?limit=10&page=1 HTTP/1.1
Host: your-domain.com
Content-Type: application/json
成功响应:
{
"code": 0,
"msg": "",
"total": 100,
"data": [...]
}
错误处理:
{
"code": -1,
"msg": "API 接口未开放"
}