REST API 开发指南

技术导览

StudioCMS REST API 作为强大的编程接口，赋能开发者以编程方式管理内容资源。基于 Astro DB 构建的这套 RESTful 接口，为内容操作提供简洁灵活的实现方案。

该 API 由 Astro Endpoints 技术驱动，提供标准化接口实现内容交互操作，以下为完整的架构解析：

API 令牌认证

访问受保护的 API 端点需在 Authorization 请求头中携带有效的鉴权令牌.

令牌获取路径：登录 StudioCMS 仪表板 → 用户配置中心 → API 令牌管理区域生成新令牌。

端点体系架构

StudioCMS REST API 提供多个功能端点，支持开发者与内容管理系统进行深度交互。这些端点主要服务于 StudioCMS 自身的内部处理流程，同时开放给开发者进行数据操作。以下是完整的 REST API 端点架构：

公共端点

这些端点开放访问且无需认证，仅提供 StudioCMS 内容树的只读权限，因此仅支持 GET 请求方法。

端点路径	功能说明
GET /studiocms_api/rest/v1/public/folders/	获取所有公开文件夹列表
GET /studiocms_api/rest/v1/public/folders/[id]	获取指定ID的文件夹详情
GET /studiocms_api/rest/v1/public/pages/	获取所有公开页面列表
GET /studiocms_api/rest/v1/public/pages/[id]	获取指定ID的页面详情

受保护端点（需认证令牌）

完整管理接口支持多种HTTP方法：

端点路径	支持方法	功能说明
/studiocms_api/rest/v1/folders/	GET, POST	文件夹列表获取/新建
/studiocms_api/rest/v1/folders/[id]	GET, PATCH, DELETE	指定文件夹操作
/studiocms_api/rest/v1/pages/	GET, POST	页面列表获取/新建
/studiocms_api/rest/v1/pages/[id]	GET, PATCH, DELETE	指定页面操作
/studiocms_api/rest/v1/pages/[id]/history/	GET	页面历史版本列表
/studiocms_api/rest/v1/pages/[id]/history/[id]	GET, PUT	特定历史版本操作
/studiocms_api/rest/v1/settings/	GET, PATCH	系统配置获取/更新
/studiocms_api/rest/v1/users/	GET	用户列表获取
/studiocms_api/rest/v1/users/[id]	GET, PATCH, DELETE	指定用户操作