REST API接口设计时,HTTP状态码204与404的区别

在设计REST API接口时遇到这个问题,当请求的数据在数据库中不存在时,究竟应该返回204还是404状态码?

204表示No Content,直接翻译过来是内容不存在,好像也可以表示请求的数据在数据库中不存在的意思。实际上,No Content是针对返回报文的内容而言,表示报文中只有报文头中有内容,报文体中没有内容。这适合于这样一种情形:客户端向服务器提交一些无需服务器返回数据的请求,此时服务器成功执行请求后仅给客户端返回一个报文头,报文头中包含一些任务执行状态信息。

而404表示Not Found,直接翻译过来是没有找到,与数据库中查不到所请求的资源意思吻合。

进一步地,我们再来辨析一下,2xx是服务器正确执行的意思,4xx是客户端错误请求的意思。比较如下三种情况:

  • GET /users/{userId}/albums/{albumId} 请求用户某个专辑,如果albumId对应的专辑不存在,这是一种错误请求(请求不存在的资源),使用404状态码更合适
  • GET /users/{userId}/albums 请求用户的专辑列表,如果该用户未收藏任何专辑,则应该返回一个空列表,这是正确执行并正确返回,使用200状态码比使用204更合适,因为报文体并不空,有一个空列表。
  • DELETE /users/{userId}/albums/{albumId} 请求删除用户某个专辑,如果数据库中存在该专辑,成功删除后应该返回204,若数据库原本就不存在该专辑,则应该返回404.

通过这个案例,相信大家对200/204/404的适用场景比较清楚了。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
在这段引用中,作者提到了使用Spring Boot开发的RESTful API示例,该示例展示了如何使用Postman进行测试。在这个示例中,作者使用Postman发送了一个POST请求,请求的URL是"http://localhost:8080/signTest?sign=A0161DC47118062053567CDD10FBACC6",并且传递了一个参数对象 {"username":"admin", "password":"admin"}。 根据这个示例,我们可以理解,Spring Boot是一个用于构建基于Java的快速开发的框架,而RESTful API则是一种接口规范或者接口风格。它的设计思想是使用URL、HTTP方法和HTTP状态码来表示API的功能和操作。通过遵循RESTful的规范,我们可以更加直观地了解API的用途,使得接口设计更加简单和易于理解。 在这个示例中,作者展示了如何使用Postman进行API的测试。通过发送不同的HTTP请求(例如GET、POST等),我们可以测试API的各种功能和操作。在这个示例中,作者使用POST请求来测试签名验证功能,通过对参数进行签名验证,可以确保请求的参数与签名值匹配。如果不匹配,则请求将被拒绝并返回错误信息。 综上所述,这个示例展示了如何使用Spring Boot开发RESTful API,并使用Postman进行测试。通过这个示例,我们可以学习到如何使用不同的HTTP请求方法测试API的功能,并且了解到如何使用签名验证来提高接口的安全性。<span class="em">1</span><span class="em">2</span> #### 引用[.reference_title] - *1* [springboot RESTful API接口demo](https://blog.csdn.net/Little_Donkey_/article/details/118192781)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] - *2* [SpringBoot2 API接口签名实现(接口参数防篡改)](https://blog.csdn.net/mingpingyao/article/details/119910694)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值