帮助中心

帮助中心首页

项目	内容
接口描述	帮助中心首页
接口地址	/console/v1/help/index
请求方式	GET
接口版本	v1

请求参数

无

响应参数

name	type	default	desc
index	array	-	desc:帮助中心首页列表
index[].id	int	-	desc:帮助文档分类ID
index[].name	string	-	desc:帮助文档分类名称
index[].helps	array	-	desc:帮助文档列表
index[].helps[].id	int	-	desc:帮助文档ID
index[].helps[].title	string	-	desc:帮助文档标题

帮助文档列表

项目	内容
接口描述	帮助文档列表
接口地址	/console/v1/help
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
keywords	string	-	搜索范围标题validate:optional	desc:关键字

响应参数

name	type	default	desc
list	array	-	desc:帮助文档列表
list[].id	int	-	desc:帮助文档分类ID
list[].name	string	-	desc:帮助文档分类名称
list[].helps	array	-	desc:帮助文档列表
list[].helps[].id	int	-	desc:帮助文档ID
list[].helps[].title	string	-	desc:帮助文档标题
list[].helps[].search	boolean	-	desc:是否被关键字匹配

帮助文档详情

项目	内容
接口描述	帮助文档详情
接口地址	/console/v1/help/:id
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
id	int	-	validate:required	desc:帮助文档ID

响应参数

name	type	default	desc
help	object	-	desc:帮助文档
help.id	int	-	desc:帮助文档ID
help.title	string	-	desc:标题
help.content	string	-	desc:内容
help.keywords	string	-	desc:关键字
help.attachment	string	-	desc:附件
help.create_time	int	-	desc:创建时间
help.update_time	int	-	desc:更新时间
help.prev	object	-	desc:上一篇文档
help.prev.id	int	-	desc:文档ID
help.prev.title	string	-	desc:标题
help.next	object	-	desc:下一篇文档
help.next.id	int	-	desc:文档ID
help.next.title	string	-	desc:标题