创建文档

创建于 2024-08-15 / 最近更新于 2024-08-16 / 224
字体： [默认] [大] [更大]

基本信息

接口地址： 您的域名/?m=Doc&a=action

请求方式： POST

Get参数请求

参数 示例值 类型 默认值 是否必填 描述
m Doc string - 必填 控制器
a action string - 必填 方法

Header参数请求

参数 示例值 类型 默认值 是否必填 描述
Authorization base64(key:secret) string - 必填

Body参数请求

请求方式： JSON

示例格式：

{
  "title": "我是API创建的文档",
  "version": "1.0",
  "open": 0,
  "open_nav": 0,
  "open_sidebar": 1,
  "createtime": "2024-08-01",
  "cover": "",
  "read_organize": "",
  "attr": "",
  "copyright": "",
  "listsort": 0
}
参数 示例值 类型 默认值 是否必填 描述
title 我是API创建的文档 string - 必填 文档标题
version 1.0 string - 必填 文档的版本号
open 0 int - 必填 0表示公开 1表示登录查看
open_nav 0 string - 必填 0表示关闭导读 1表示打开
open_sidebar 1 string - 必填 0表示目录收起 1表示展开
createtime 2024-08-01 date - 必填 文档创建日期，以YY-MM-DD H:I:S
cover - string - 非必填 上传文档封面的URL，详情请参考上传文件接口
read_organize 1,2,3 string - 非必填 允许查看文档的用户分组，ID以英文逗号区分
attr 1,2 string - 非必填 文档属性，属性ID用英文逗号分开
copyright - string - 非必填 当前文档全局的版权声明
listsort 0 string 0 非必填 文档排序值 （升序）

成功

成功时返回的结构

{
  "status": 200,
  "msg": "文档创建完成",
  "data": {
    "id": "21"
  },
  "url": "/?g=Doc&m=Doc&a=index",
  "waitSecond": "3",
  "token": "e94934d7934a6dfdea9fab82622c0f4f_8442730042028"
}

返回参数说明

参数 类型 描述
id string 成功创建的文档ID
0 人点赞过