获取文档详情¶
- 接口地址:
/api/docs/detail/:id
- HTTP请求方式
GET
- 请求参数
id (path): 文档 ID
- 响应代码
共通响应
示例:
curl -X GET "$BASE_URL/api/docs/detail/1"
响应示例:
JSON:
{ "code": 0, "message": "OK", "data": { "id": "1", "name": "", "parent_id": 0, "locale": "", "ct": 0 } }
创建文档¶
- 接口地址:
/api/docs/create
- HTTP请求方式
POST
- 请求参数
parent_id (form, optional): 父目录 ID,默认 0
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/docs/create" -d "parent_id=0"
响应示例:
JSON:
{ "code": 0, "message": "文档创建成功", "data": { "id": "1", "locale": "", "parent_id": 0, "name": "未命名.docx", "ct": 0 } }
重命名文档¶
- 接口地址:
/api/docs/rename
- HTTP请求方式
POST
- 请求参数
id (form, required): 文档 ID
name (form, required): 新名称
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/docs/rename" -d "id=1&name=新文档.docx"
响应示例:
JSON:
{ "code": 0, "message": "OK", "data": {} }
download document¶
- 接口地址:
/api/docs/download
- HTTP请求方式
GET
- 请求参数
id (query): 文档 ID
- 响应代码
共通响应
示例:
curl -X GET "$BASE_URL/api/docs/download?id=1"
响应示例:
返回文件流或重定向到下载地址
创建文档变更¶
- 接口地址:
/api/docs/createchange
- HTTP请求方式
POST
- 请求参数
id (form, required): 文档 ID
变更内容等(见实现,用于协同编辑)
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/docs/createchange" -d "id=1"
响应示例:
JSON:
{ "code": 0, "message": "OK", "data": {} }