Skip to content

文档接口

获取文档列表

http
GET /api/v1/documents

查询参数

参数类型说明
pagenumber页码,默认 1
pageSizenumber每页数量,默认 20
categorystring分类筛选
keywordstring关键词搜索

获取文档详情

http
GET /api/v1/documents/:id

创建文档

http
POST /api/v1/documents

请求参数

参数类型必填说明
titlestring文档标题
contentstring文档内容(Markdown)
categorystring分类 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
    }
  ]
}
最近更新