MatePress CMS API 官方文档
  1. 文档
MatePress CMS API 官方文档
  • 文档
    • MatePress CMS 快速指南
  • MatePress CMS API
    • Post Management
      • List Posts
      • Store Post
      • Update Post
      • Delete Post
    • User Management
      • List Users
      • Store User
      • Update User
      • Delete User
      • Get Profile
      • Update Profile
    • Category Management
      • List Categories
      • Store Category
      • Update Category
      • Delete Category
    • Media Management
      • List Media
      • Upload Media
      • Sync Media
      • Delete Media
    • Menu Management
      • List Menus
      • Store Menu
      • Update Menu
      • Delete Menu
      • Add Menu Item
      • Update Menu Order
      • Delete Menu Item
    • Page Management
      • List Pages
      • Store Page
      • Update Page
      • Delete Page
    • System Settings
      • Get Storage Settings
      • Save Storage Settings
      • Get AI Settings
      • Save AI Settings
    • Theme Management
      • List Themes
      • Scan Themes
      • Activate Theme
      • Get Theme Settings
      • Save Theme Settings
      • Delete Theme
    • Frontend
      • Home
      • Get Post
      • Get Category
      • List Posts
      • Get Page
  1. 文档

MatePress CMS 快速指南

本文档提供了 MatePress CMS 核心模块的数据结构与路由定义的快速参考。

目录#

概览
核心模块
JSON 定义说明

概览#

MatePress CMS 的后台管理基于 Laravel Resource Controller 构建。本目录下的 JSON 文件描述了各个管理模块的:
基础路由 (Base URL)
支持的 HTTP 方法 (GET, POST, PUT, DELETE)
请求参数规范 (Parameters)

核心模块#

以下是系统包含的主要模块及其定义文件:
模块名称定义文件说明
文章管理posts.json管理文章发布、编辑、状态流转 (Draft/Published)
页面管理pages.json管理独立页面(如关于我们),支持层级结构
用户管理users.json管理管理员账户与权限
主题管理themes.json主题扫描、激活与配置 (theme.json)
设置管理settings.json系统级配置(AI集成, 对象存储, 站点信息)
分类管理categories.json文章分类管理
菜单管理menus.json前台导航菜单管理
媒体管理media.json图片与文件管理 (支持 Local/COS/OSS)
前端接口frontend.json公开的前端访问接口

开发规范#

1. 路由与认证#

路由前缀: 默认后台路由前缀为 /admin。
认证方式:
Web 访问: 使用标准的 Laravel Session/Cookie 认证 (auth 中间件)。
API 访问: 部分接口支持 Sanctum Token 认证 (需在 Request Header 中携带 Authorization: Bearer <token>)。

2. 数据交互#

请求格式:
常规数据: application/x-www-form-urlencoded 或 application/json
文件上传: multipart/form-data
响应格式:
页面请求返回 HTML 视图。
AJAX/API 请求通常返回 JSON 数据 (需设置 Accept: application/json)。

JSON 定义说明#

每个 .json 文件遵循以下结构:
{
    "module": "模块名称",
    "base_url": "/admin/resource",
    "endpoints": [
        {
            "name": "操作名称",
            "method": "HTTP方法",
            "uri": "具体路径",
            "parameters": [ ... ]
        }
    ]
}
这些定义可用于生成 API 文档或辅助前端/客户端开发。

最后更新: 2026-01-25 03:54:35
修改于 2026-01-24 19:57:49
下一页
List Posts
Built with