用户数据同步接口设计

用户数据同步接口设计

Endpoint:

POST /api/user/sync

请求头 (Request Headers):

  • Content-Type: application/json
  • Authorization: Bearer {访问令牌}

请求体 (Request Body):

{
  "users": [
    {
      "id": "123",
      "username": "example_user",
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Doe",
      "role": "user"
    },
    {
      "id": "456",
      "username": "another_user",
      "email": "[email protected]",
      "first_name": "Jane",
      "last_name": "Smith",
      "role": "admin"
    }
    // 更多用户数据...
  ]
}

响应 (Response):

{
  "success": true,
  "message": "用户数据成功同步",
  "errors": []
}

说明:

  • Endpoint: /api/user/sync 是用户数据同步的接口路径。
  • 请求头: 包含了请求的内容类型和授权信息,以Bearer Token形式进行身份验证。
  • 请求体: 用户数据以JSON格式发送,每个用户由ID、用户名、邮箱、姓名、角色等信息组成。
  • 响应: 返回一个包含成功与否信息、消息和错误列表的 JSON 响应。