端点示例文档 📚

以下为常见 API 端点示例，包含请求方法、路径及参数说明：

🌐 GET 请求示例

  • 获取用户列表
    路径: /api/users
    参数: ?page=1&limit=10
    示例响应: 

    {
  "data": [
    {"id": 1, "name": "张三"},
    {"id": 2, "name": "李四"}
  ]
}
    HTTP_Request_Example

  • 获取文章详情
    路径: /api/articles/{id}
    参数: ?withComments=true
    示例响应: 

    {
  "title": "Markdown 教程",
  "content": "学习如何使用 Markdown 格式化文本...",
  "comments": []
}
    Get_Method_Icon

✏️ POST 请求示例

  • 创建新用户
    路径: /api/users
    请求体: 
    {
  "name": "王五",
  "email": "wangwu@example.com"
}
    POST_Request_Example

🔒 安全提示

  • 所有请求需携带 Authorization 头，格式为 Bearer <token>
  • 敏感操作需通过 POST 或 PUT 方法提交，避免使用 GET

如需进一步了解 API 设计规范，可访问 社区文档中心 获取完整指南 📚