文档接口
获取文档列表
http
GET /api/v1/documents查询参数
| 参数 | 类型 | 说明 |
|---|---|---|
| page | number | 页码,默认 1 |
| pageSize | number | 每页数量,默认 20 |
| category | string | 分类筛选 |
| keyword | string | 关键词搜索 |
获取文档详情
http
GET /api/v1/documents/:id创建文档
http
POST /api/v1/documents请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | string | 是 | 文档标题 |
| content | string | 是 | 文档内容(Markdown) |
| category | string | 否 | 分类 ID |
更新文档
http
PUT /api/v1/documents/:id删除文档
http
DELETE /api/v1/documents/:id获取文档分类
http
GET /api/v1/documents/categories响应示例
json
{
"code": 0,
"data": [
{
"id": "1",
"name": "使用指南",
"count": 10
},
{
"id": "2",
"name": "API 文档",
"count": 5
}
]
}