基本CRUD操作的REST响应模式是什么?
如果我想在一个特定的资源中插入一个新的条目,我只需要发送一个带有JSON格式的必要数据的POST到服务器。服务器响应{ 'id':xx },其中xx是新条目的id。成功的更新请求也是如此。
失败时,我总是发送一个404,其中包含一个具有idError和如下描述的json对象。
{idError:'100', errorDesc: 'SQL error'}
{idError:'101', errorDesc: 'Missing resource identifier'}
但是因为我不知道任何模式,所以我想得到一些关于如何在失败时正确返回JSON的提示,以及设置HTTP状态码沿着响应是否是一个好的实践。
2条答案
按热度按时间oknwwptz1#
成功后,您应该使用200个状态代码(就像您正在做的那样):
update
和get
操作。post
。返回创建的资源。delete
中使用它,但是如果你想返回一些东西(比如被删除的资源),使用200。如果您稍后要处理数据,请使用202。你不太可能会使用它,但要注意它。
要使用的错误状态取决于错误的类型。400是客户端错误,例如他们向您发送错误的信息。500是服务器错误--你这边的错误。
您可能不会使用404,因为这意味着资源未找到。如果错误是由于无效的输入,你应该使用400 -- bad request。Be aware of the HTTP status codes,并尝试使用适当的一个。
ftf50wuq2#
您可以使用任何标准,如JSON API。
从他们的网站摘要:
如果你曾经和你的团队争论过JSON响应的格式,JSON:API可以帮助你停止自行车整理,专注于重要的事情:您申请
检查规格https://jsonapi.org/format/