API 参考文档 💡

概述

欢迎访问我们的 API 参考文档！这里提供了所有接口的详细说明，包含请求参数、响应格式及使用示例。如需了解 API 的基础概念，可前往 API 指南 查看。

请求方法

以下为支持的 HTTP 方法及示例：

• GET 🟢：获取资源
  示例：GET /api/data
• POST 🟡：创建资源
  示例：POST /api/create
• PUT 🟣：更新资源
  示例：PUT /api/update
• DELETE 🟦：删除资源
  示例：DELETE /api/delete

响应格式

所有 API 响应均采用 JSON 格式，包含以下字段：

• code：状态码（200 表示成功）
• data：返回的数据内容
• message：描述信息

使用示例

获取用户数据

GET /api/users/123

响应示例：

{
  "code": 200,
  "data": {"name": "张三", "id": 123},
  "message": "请求成功"
}

创建新资源

POST /api/create
Content-Type: application/json

{
  "name": "测试资源"
}

常见问题

⚠️ Q1: 如何处理请求失败？
A: 检查 code 字段，400 系列为客户端错误，500 系列为服务器错误。

⚠️ Q2: 支持哪些数据格式？
A: 目前仅支持 JSON，更多格式请查看 数据格式说明。