文档

查看我们的内容文档与文档接口说明

内容文档

查看我们的最新文档与资料

暂无文档。

接口文档

文档接口由本站 /api/docs 提供，字段与参数说明如下

GET/api/docs

文档列表

分页查询当前主体下的文档列表；优先通过 ?org= 识别主体，否则按当前访问域名识别。

查询参数

参数类型必填默认说明
pageinteger否1页码，从 1 开始。
pageSize / page_sizeinteger否10每页条数，最大 50。
keywordstring否-按文档名称、描述或 slug 模糊搜索。
orgstring否-主体标识（如 day-x-time）；不传时按访问域名识别。

响应示例

{
  "list": [
    {
      "id": "9d87bf03-1a47-4b88-b82b-8f21d8123d12",
      "slug": "about-us",
      "type_id": "196f23cc-86b6-4a30-ad8b-0d5b0b9862cc",
      "name": "关于我们",
      "description": "",
      "cover_image": "",
      "created_at": 1773230915,
      "updated_at": 1777508688
    }
  ],
  "total": 1
}

错误示例

{
  "error": "organization not found"
}
GET/api/docs/:identifier

文档详情

按 UUID 或 slug 获取文档详情；identifier 为 UUID 时按 id 查询，否则按 slug 查询。

路径参数

参数类型必填默认说明
identifierstring是-文档 id 或 slug。

查询参数

参数类型必填默认说明
orgstring否-主体标识（如 day-x-time）；不传时按访问域名识别。

响应示例

{
      "id": "9d87bf03-1a47-4b88-b82b-8f21d8123d12",
  "slug": "about-us",
  "type_id": "196f23cc-86b6-4a30-ad8b-0d5b0b9862cc",
  "name": "关于我们",
  "description": "",
  "content": "<p><strong>测试11</strong></p>",
  "cover_image": "",
  "images": [],
  "files": [],
  "created_at": 1773230915,
  "updated_at": 1777508688,
      "project_id": "1ecda70b-a46b-4b0d-ba67-f9a0ea457238",
      "organization_id": "d7e83e27-a2a1-4d01-8f2a-93de0d9cf958"
}

错误示例

{
  "error": "doc not found"
}