使用指南

一、快速入门

1.1 什么是 AnQiCMS API AnQiCMS 是一个基于 Go 语言开发的开源内容管理系统，提供了完整的 API 接口供开发者调用。API 采用 RESTful 设计风格，支持 JSON 格式的数据交互，允许开发者通过 HTTP 请求与系统进行交互，获取、创建、更新或删除内容。 1.2 API 基础概念 API 基础路径：/api - 所有 API 请求都需要以该路径为前缀
二、API 基础结构

2.1 API 基础路径和请求方式所有 API 接口都通过以下基础路径访问： {域名地址}/api/接口路径例如：https://www.anqicms.com/api/archive/list API 支持的 HTTP 请求方式包括： GET - 获取数据 POST - 创建数据或提交表单，更新数据、删除数据 2.2 认证方式部分接口需要用户认证，系统采用 JWT Token
三、API 部分接口分类详解

以下是 AnQiCMS 提供的 API 接口分类，以及部分接口参数，更多的文档接口以及参数配置，请参考详细文档。 3.1 内容管理接口内容管理接口用于处理网站的核心内容，包括文档、分类、标签等。 3.1.1 获取文档详情接口接口路径：/api/archive/detail 请求方式：GET 功能：获取单个文档详细信息参数： id (int, 必填) - 文档ID filename
四、请求参数详解

4.1 通用参数格式 API 接口支持两种参数传递方式： Query 参数：通过 URL 查询字符串传递，适用于 GET 请求 Body 参数：通过请求体传递，适用于 POST 请求 4.2 分页参数说明大多数列表接口支持分页功能，通用分页参数包括：参数名类型说明 page int 页码，默认为1, 部分接口使用 current 作为当前页码，请以实际接口为准 limit int
五、响应数据结构

5.1 通用响应格式所有 API 接口都遵循统一的响应格式： { "code": 0, "msg": "success message", "data": {} } 5.2 数据字段说明字段名类型说明 code int 错误码，0表示成功 msg string 错误信息或成功提示 data
六、认证与授权

6.1 JWT Token 认证 AnQiCMS 采用 JWT (JSON Web Token) 进行用户认证：用户登录成功后获取 Token 在后续请求的 Header 中携带 Token 格式：Token: {token} 6.2 需要认证的接口以下类型的接口需要用户认证：用户信息管理接口订单管理接口收藏管理接口评论发布接口购物车管理接口 6.3 Token 获取与刷新
七、调试与测试

7.1 调试工具推荐 Postman - 功能强大的 API 测试工具 curl - 命令行工具浏览器开发者工具 - 查看网络请求 7.2 常见错误及解决方案错误：Token 过期解决方案：重新登录获取新 Token 错误：参数格式错误解决方案：检查参数类型和格式是否正确错误：接口无权限解决方案：确认用户权限或检查认证信息 7.3 性能优化建议
八、实践

8.1 接口调用实践错误处理：始终检查返回的 code 值参数验证：在调用前验证参数的有效性重试机制：对于临时性错误实现重试逻辑 8.2 安全**实践 Token 保护：妥善保管认证 Token HTTPS ：始终使用 HTTPS 连接输入验证：对用户输入进行严格验证 8.3 错误处理**实践 // 示例：错误处理**实践 fetch('/api/archive/list'
九、博客站点API调用示例

我们先分析一下博客站点有哪些页面，再拆解每一个页面所需要的接口。 9.1 博客站点页面结构分析典型的博客站点通常包含以下页面： 9.1.1 主要页面类型首页 - 展示最新文章、热门文章、推荐文章等分类页 - 按分类展示文章列表标签页 - 按标签展示文章列表文章详情页 - 展示单篇文章的详细内容归档页 - 按时间归档展示文章搜索页 - 搜索结果页面关于页面 -
十、商城站点API调用示例

我们先分析一下商城站点有哪些页面，再拆解每一个页面所需要的接口。 10.1 商城站点页面结构分析典型的商城站点通常包含以下页面： 10.1.1 主要页面类型首页 - 展示最新商品、热门商品、推荐商品、促销活动等商品分类页 - 按分类展示商品列表商品详情页 - 展示单个商品的详细信息购物车页 - 用户选购商品的购物车页面订单确认页 - 确认订单信息的页面订单支付页 -