模块说明
doc 提供文档中心的两级分类树浏览与文档详情:分类接口返回分类树与当前分类信息(部分分类配置了跳转时返回 redirect);详情含已渲染正文、自定义字段与分类上下文。
鉴权级别:可选。
接口一览
| 方法 | URL | 鉴权 | 说明 |
|---|---|---|---|
| GET | /api/doc |
可选 | 文档分类树 / 分类信息(或 redirect) |
| GET | /api/doc/show/{id} |
可选 | 文档详情 |
分类浏览
请求参数
| 参数 | 必填 | 说明 |
|---|---|---|
id |
否 | 分类 ID(不传=根级) |
category_slug |
否 | 分类英文标识 |
响应
普通分类:
{
"code": "OK",
"message": "",
"data": {
"title": "接口文档",
"category_id": 5,
"doc_category": [ { "id": 5, "name": "接口文档", "children": [ { "id": 6, "name": "..." } ] } ],
"cate_info": { "id": 5, "name": "接口文档", "...": "" }
},
"errors": {},
"request_id": "9f2a5c8e1b3d7f40"
}
分类配置了外部跳转时:
{
"code": "OK",
"message": "",
"data": { "redirect": "https://example.com/other-page" },
"errors": {},
"request_id": "9f2a5c8e1b3d7f40"
}
客户端遇到 redirect 字段时应直接跳转该地址,不渲染列表。
文档详情
GET /api/doc/show/128
{
"code": "OK",
"message": "",
"data": {
"title": "文档详情",
"doc": { "id": 128, "title": "...", "content": "<p>……</p>", "click": 540, "...": "" },
"defined": { "...": "自定义字段" },
"cate_info": { "...": "所属分类详情" }
},
"errors": {},
"request_id": "9f2a5c8e1b3d7f40"
}
注意事项
- 分类树键为
doc_category(含children两级结构); - 详情键为
doc,正文content已渲染为 HTML; - 详情每次读取递增
click。