API 概述

本文档介绍系统的 API 接口。

基础信息

• 基础URL：/api/
• 请求格式：JSON
• 响应格式：JSON

接口列表

获取文档列表

请求

GET /api/docs

参数

| 参数 | 类型 | 必填 | 说明 |

|------|------|------|------|

| page | int | 否 | 页码，默认1 |

| limit | int | 否 | 每页数量，默认20 |

响应

{
  "code": 200,
  "data": {
    "list": [],
    "total": 0
  }
}

获取文档详情

请求

GET /api/docs/{slug}

响应

{
  "code": 200,
  "data": {
    "slug": "guide/intro",
    "title": "项目简介",
    "content": "文档内容..."
  }
}

搜索文档

请求

GET /api/search?q=关键词

响应

{
  "code": 200,
  "data": [
    {
      "slug": "guide/intro",
      "title": "项目简介",
      "snippet": "匹配的内容片段..."
    }
  ]
}

错误码

| 错误码 | 说明 |

|--------|------|

| 200 | 成功 |

| 400 | 请求参数错误 |

| 401 | 未授权 |

| 404 | 文档不存在 |

| 500 | 服务器内部错误 |