集合文件夹 API

介绍

集合文件夹 API 是一个用于管理文件夹集合的 RESTful API，它允许您创建、更新、删除文件夹集合，以及向集合中添加或删除文件夹。

接口

创建文件夹集合

POST /collections
Content-Type: application/json

{
  "name": "My collection"
}

创建文件夹集合的请求需要指定名称，请求成功后，服务器将返回以下示例响应：

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "4a3e4184-1d43-4c0e-916c-9e685f30fcaa",
  "name": "My collection",
  "folders": []
}

获取文件夹集合列表

GET /collections

获取文件夹集合列表的请求不需要任何参数，请求成功后，服务器将返回以下示例响应：

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "4a3e4184-1d43-4c0e-916c-9e685f30fcaa",
    "name": "My collection",
    "folders": []
  },
  {
    "id": "6d90e6e3-1463-4828-a413-ba2d6a2f6d77",
    "name": "Another collection",
    "folders": []
  }
]

获取文件夹集合详情

GET /collections/{id}

获取文件夹集合详情的请求需要指定集合的 ID，请求成功后，服务器将返回以下示例响应：

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "4a3e4184-1d43-4c0e-916c-9e685f30fcaa",
  "name": "My collection",
  "folders": [
    {
      "id": "9c56522f-ff1e-4b5f-88f2-72d349c67187",
      "name": "Folder 1"
    },
    {
      "id": "f8c21fd6-945d-45cb-bce2-96a9fd2fb603",
      "name": "Folder 2"
    }
  ]
}

更新文件夹集合

PUT /collections/{id}
Content-Type: application/json

{
  "name": "New name"
}

更新文件夹集合的请求需要指定集合的 ID 以及新名称，请求成功后，服务器将返回以下示例响应：

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "4a3e4184-1d43-4c0e-916c-9e685f30fcaa",
  "name": "New name",
  "folders": [
    {
      "id": "9c56522f-ff1e-4b5f-88f2-72d349c67187",
      "name": "Folder 1"
    },
    {
      "id": "f8c21fd6-945d-45cb-bce2-96a9fd2fb603",
      "name": "Folder 2"
    }
  ]
}

删除文件夹集合

DELETE /collections/{id}

删除文件夹集合的请求需要指定集合的 ID，请求成功后，服务器将返回一个空响应。

向文件夹集合中添加文件夹

POST /collections/{collection_id}/folders
Content-Type: application/json

{
  "name": "New folder"
}

向文件夹集合中添加文件夹的请求需要指定集合的 ID 以及新文件夹的名称，请求成功后，服务器将返回以下示例响应：

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "9c56522f-ff1e-4b5f-88f2-72d349c67187",
  "name": "New folder"
}

从文件夹集合中删除文件夹

DELETE /collections/{collection_id}/folders/{folder_id}

从文件夹集合中删除文件夹的请求需要指定集合 ID 和文件夹 ID，请求成功后，服务器将返回一个空响应。

结论

集合文件夹 API 允许您轻松地管理文件夹集合，它提供了简单、易于使用的 RESTful 接口，适用于各种应用程序和场景。