Skip to content
On this page

项目 API

项目管理相关的 API 接口。

获取项目列表

GET /api/projects

查询参数

参数类型说明
pagenumber页码,默认 1
pageSizenumber每页数量,默认 20
keywordstring搜索关键词

响应示例

json
{
  "success": true,
  "data": {
    "list": [
      {
        "id": "uuid",
        "name": "示例项目",
        "description": "项目描述",
        "createdAt": "2026-01-01T00:00:00Z",
        "updatedAt": "2026-01-01T00:00:00Z"
      }
    ],
    "total": 100
  }
}

创建项目

POST /api/projects

请求参数

参数类型必填说明
namestring项目名称
descriptionstring项目描述
isPublicboolean是否公开

获取项目详情

GET /api/projects/{id}

响应示例

json
{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "示例项目",
    "description": "项目描述",
    "files": [],
    "layers": [],
    "createdAt": "2026-01-01T00:00:00Z"
  }
}

更新项目

PUT /api/projects/{id}

请求参数

参数类型必填说明
namestring项目名称
descriptionstring项目描述

删除项目

DELETE /api/projects/{id}

分享项目

POST /api/projects/{id}/share

请求参数

参数类型必填说明
permissionstring权限:read/write/admin
expiresInnumber过期时间(天)

基于 MIT 许可发布