Rest API验证/错误消息最佳实践

时间:2016-08-19 23:35:46

标签: api rest

在以下场景中,对客户端的最佳响应消息是什么?

想象一下,我有一个名为/ users的端点,客户端可以使用PUT来更新用户的某些属性。

允许客户端更新某些用户属性,但其他属性没有。 例如,客户端可以更新name和birthDate,但他无法更新代码和registerDate。

如果客户端尝试更新不允许的属性,那么对客户端的最佳响应消息是什么?

回应1

400错误请求

{
    “err”: “You can’t update the properites: code and registerDate.”
}

回复2

400错误请求

{
    “err”: “You can update only the properties: name and birthDate.”
}

也就是说,我应该回复他试图更新的属性,但是他不能,或只响应他可以更新的属性?

此外,如何才能更好地了解最佳做法,以便正确通知我的API可以返回的错误和验证消息?有一些指导或书吗?

1 个答案:

答案 0 :(得分:0)

以下是关于服务API的最佳做法的非常好的文章:http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api

至于你的问题,它真的是关于你作为开发者的偏好。我只是建议非常好地记录你的API。