API 文档

本页面提供接口说明与调用示例。

认证

所有接口均需在请求头中携带访问令牌：

Authorization: Bearer <your_token>

接口列表

获取用户信息

GET /api/v1/user/{id}

路径参数

参数	类型	必填	说明
id	string	是	用户唯一标识

响应示例

{
  "code": 0,
  "data": {
    "id": "10001",
    "name": "张三",
    "email": "zhangsan@example.com"
  }
}

创建订单

POST /api/v1/orders

请求体

{
  "productId": "P-2026",
  "quantity": 2
}

响应示例

{
  "code": 0,
  "data": {
    "orderId": "ORD-20260625-0001",
    "status": "created"
  }
}

错误码说明

错误码	说明
0	成功
401	未授权 / 令牌无效
404	资源不存在
500	服务器内部错误

:::tip 提示 如果你的项目有标准的 OpenAPI（Swagger）规范文件，可安装 docusaurus-plugin-openapi-docs 插件自动生成交互式 API 文档。 :::