更新文档首页

创建于 2024-08-19 / 最近更新于 2024-08-19 / 123

字体： [默认] [大] [更大]

基本信息

接口地址： 您的域名/?m=Article&a=doc

请求方式： PUT

Get参数请求

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

Header参数请求

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

Body参数请求

请求方式： JSON

富文本API格式

示例格式：

{
  "id": "21",
  "editor": "0",
  "content": "更新文档首页",
  "doc_keyword": "",
  "doc_description": ""
}

参数	示例值	类型	默认值	是否必填	描述
id	21	string	-	必填	文档ID (必须是字符串)
editor	0	string	-	必填	编辑器类型 0:富文本编辑器 1:MD编辑器
content	更新文档首页	string	-	必填	富文本编辑器的内容
doc_keyword		string	-	非必填	seo keyword的信息
doc_description		string	-	非必填	seo description的信息

MD编辑器API格式

示例格式：

{
  "id": "21",
  "editor": "1",
  "md": "我是MD编辑器",
  "html" : "<p>我是MD编辑器</p>",
  "doc_keyword": "",
  "doc_description": ""
}

参数	示例值	类型	默认值	是否必填	描述
id	21	string	-	必填	文档ID (必须是字符串)
editor	1	string	-	必填	编辑器类型 0:富文本编辑器 1:MD编辑器
md	更新文档首页	string	-	必填	MD编辑器的内容
html	更新文档首页	string	-	必填	MD格式转HTML的内容，预留给切换用
doc_keyword		string	-	非必填	seo keyword的信息
doc_description		string	-	非必填	seo description的信息

成功

成功时返回的结构

{
  "status": 200,
  "msg": "文档首页内容更新完成",
  "data": {
    "url": "/?g=Doc&m=Article&a=index&id=21"
  },
  "url": "",
  "waitSecond": "3",
  "token": "e8620f4df16a51bef58060936bff131f_8444318953228"
}

0 人点赞过