用于获取系统在管理端的帮助文档配置模块接口数据,一般用在系统在线帮助的业务场景。
文档分组接口
获取帮助文档分组列表接口。
请求方法:GET
是否鉴权:否
请求编码:Content-Type:application/x-www-form-urlencoded
响应编码:Content-Type:application/json;charset=UTF-8
请求地址:index/article/documentGroup
请求参数:
参数名 | 参数类型 | 是否必填 | 参数说明 | 示例值 |
---|
- 成功示例:
javascript
{
"data": [
{
"uid": "535853126445126010",
"title": "关于我们",
"children": [
{
"title": "隐私协议",
"group_uid": "535853126445126010",
"uid": "535853384837033110"
}
]
}
],
"code": 100,
"msg": "请求成功"
}
参数名 | 参数类型 | 是否必有 | 参数说明 | 示例值 |
---|---|---|---|---|
uid | string | 是 | 文档分组id | |
title | string | 是 | 文档分组标题 | |
children.uid | string | 是 | 文档分组子级id | 点击子级标题时,跳转对应的内容详情页需要传递该id |
children.title | string | 是 | 文档分组子级标题 | |
children.group_uid | string | 是 | 文档分组id |
- 失败示例:
javascript
{
"code": 101,
"data": [],
"msg": "请求失败"
}