获取文档

简要描述

点击文档获取文档内容

请求 URL

请求方式

  • GET

请求示例

请求参数

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "id": "106",
    "menuId": "193",
    "title": "Open-Idea-test",
    "content": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"marks\":[{\"type\":\"comment\",\"attrs\":{\"threadId\":\"ba155ff9-2c56-4848-8dfc-6c892fd746bf\"}}],\"text\":\"一个免费且好用的编辑器\"}]},{\"type\":\"image\",\"attrs\":{\"src\":\"https://cdn.openbytecode.com/1781870697689530369.png\",\"alt\":null,\"title\":null,\"width\":404.2,\"height\":403.767}},{\"type\":\"heading\",\"attrs\":{\"id\":\"fc9a9f46-2b27-4914-a61d-cedebc8e16b9\",\"data-toc-id\":\"fc9a9f46-2b27-4914-a61d-cedebc8e16b9\",\"level\":1},\"content\":[{\"type\":\"text\",\"marks\":[{\"type\":\"comment\",\"attrs\":{\"threadId\":\"2e7a3a23-38c2-4430-8709-05a7a7a17011\"}}],\"text\":\"快速开始\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"marks\":[{\"type\":\"comment\",\"attrs\":{\"threadId\":\"b26bb319-3dcf-4f64-a28b-044c75ccced0\"}}],\"text\":\"这是一个长文本这是一个长文本这\"},{\"type\":\"text\",\"text\":\"是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文本这是一个长文\"},{\"type\":\"text\",\"marks\":[{\"type\":\"comment\",\"attrs\":{\"threadId\":\"9739fcac-3750-4950-b0f0-734e07251fda\"}}],\"text\":\"本这是一个长文本这是一个长文本这是一个\"},{\"type\":\"text\",\"text\":\"长文本\"}]},{\"type\":\"table\",\"content\":[{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableHeader\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"姓名\"}]}]},{\"type\":\"tableHeader\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"年龄\"}]}]},{\"type\":\"tableHeader\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"性别\"}]}]}]},{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"小明\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"20\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"男\"}]}]}]},{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"小花\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"20\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":null},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"女\"}]}]}]}]},{\"type\":\"heading\",\"attrs\":{\"id\":\"caf492c3-2a94-429b-a4ed-f74c0398fea1\",\"data-toc-id\":\"caf492c3-2a94-429b-a4ed-f74c0398fea1\",\"level\":2},\"content\":[{\"type\":\"text\",\"marks\":[{\"type\":\"comment\",\"attrs\":{\"threadId\":\"5160756b-9425-4d31-92d6-5d6f61507804\"}}],\"text\":\"测试标题1\"}]},{\"type\":\"heading\",\"attrs\":{\"id\":\"574caa42-7113-42c1-9636-0fed63784590\",\"data-toc-id\":\"574caa42-7113-42c1-9636-0fed63784590\",\"level\":2},\"content\":[{\"type\":\"text\",\"text\":\"测试标题2\"}]},{\"type\":\"heading\",\"attrs\":{\"id\":\"d82b40cf-8c22-41b3-be65-602df4f9818e\",\"data-toc-id\":\"d82b40cf-8c22-41b3-be65-602df4f9818e\",\"level\":3},\"content\":[{\"type\":\"text\",\"text\":\"测试标题\"}]}]}",
    "comments": []
  },
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
idnumber主键
menuIdnumber菜单 id
titlestring标题
contentstring内容
commentsstring评论列表
successboolean是否成功

创建文档

简要描述

创建文档

请求 URL

请求方式

  • POST

请求示例

{
  "pid": 1,
  "type": 0
}

请求参数

参数名类型必选说明
pidnumber父级id
typenumber文件夹/文件

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": null,
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
successboolean是否成功

更新文档

简要描述

更新文档

请求 URL

请求方式

  • PUT

请求示例

{
  "id": 10,
  "menuId": 1,
  "title": "Open-Idea",
  "content": "文档内容"
}

请求参数

参数名类型必选说明
idnumber文档id
menuIdstring菜单 id
titlenumber文档标题
contentnumber文档内容

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": null,
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
successboolean是否成功