无标题文档

更新用户信息

允许已授权的用户通过此接口更新自己的信息。

:::tips

• URL：/api/user
• Method：PUT
• 需要登录：是
• 需要鉴权：是

:::

请求参数

参数	类型	约束
first_name	String	1 到 30 个字符
last_name	String	1 到 30 个字符

:::info
💡 注意，id 和 email 字段目前是只读属性，不允许通过此接口进行修改。

:::

请求示例

可以仅传递部分请求参数。

{
    "first_name": "John"
}

可以通过传递空字符串来清除数据。

{
    "last_name": ""
}

成功响应

:::tips
条件：请求参数合法，并且用户身份校验通过。

状态码：200 OK

响应示例：响应会将修改后的用户信息数据返回，一个id为 1234 的用户设置他们的姓名后将会返回：

:::

{
    "id": 1234,
    "first_name": "Joe",
    "last_name": "Bloggs",
    "email": "joe25@example.com"
}

错误响应

:::tips
条件：请求数据非法，例如 fist_name 的长度过长。

状态码：400 BAD REQUEST

响应示例:

:::

{
    "first_name": "Please provide maximum 30 character or empty string"
}

注意事项

:::info
💡 如果用户的用户信息不存在，将会使用请求的数据创建一个新的用户信息。

:::