关于 RESTful API 中 HTTP 状态码的定义
最近正好使用了一会儿 Koa ,在这说一下自己对各个 请求码的见解和使用场景,懒人直接看 200、400、401、403、404、500 就可以了。
其中 2XX/3XX 其实都是请求成功,但是结果不同。4XX 是请求出错,5XX 是服务器处理出现错误。
200
这个最容易理解,就是正确的请求返回正确的结果,如果不想细分正确的请求结果都可以直接返回200。
201
表示资源被正确的创建。比如说,我们 POST 用户名、密码正确创建了一个用户就可以返回 201。
202
请求是正确的,但是结果正在处理中,没法返回对应的结果。比如说,我们请求一个需要大量计算的结果,但是并没有计算结束时,可以返回这个,这时候客户端可以通过轮询等机制继续请求。
203
请求的代理服务器修改了源服务器返回的 200 中的内容,一般用不到。比如说,我们通过代理服务器向服务器 A 请求用户信息,服务器 A 正常响应,但代理服务器命中了缓存并返回了自己的缓存内容,这时候它返回 203 告诉我们这部分信息不一定是最新的,我们可以自行判断并处理。
204
请求正确,但是没有需要返回的内容。比如说,我们请求删除某个用户,删除成功可以返回 204。
205
类似 204,但是要求请求者重置视图,一般也用不到。比如说,我们请求删除某个用户,服务器返回 205 的话,我们就刷新现在的用户列表。
206
请求成功,但根据请求头只返回了部分内容。比如说,我们下载一部片,共有 10 部分,我们把请求也分成了 10 次(防止一次请求过大),这时候服务器就可以返回 206 并在其头部告诉我们这是哪一部分,然后再根据这个信息进行拼装。
300
请求成功,但结果有多种选择。比如说,我们下载一部片,服务器有 avi、mp4 等格式,这时候可以返回 300,并在 body 里告知有哪些格式,然后用户可以根据这些格式再次请求。
301
请求成功,但是资源被永久转移。比如说,我们要下载葫芦娃,但是由于旧的存储服务商涨价了,现在要使用新的存储服务了,要去新地址下载,这时候可以返回 301,并在 header 的 Location 中告知新的地址,以后也应当到这个地址下载。
302
请求成功,但是资源被临时转移了。和 301 不同的是,除非是 HEAD 请求,否则新地址的信息应当在 body 中返回,并且资源只是临时转移,以后不应当通过新地址来下载。
303
类似 302,但要求使用 GET 来访问新的地址来获取资源。
304
请求的资源并没有被修改过。比如说,我们发送请求想看看 5.20 后的情侣信息,服务器查询没有新的情侣信息产生,这时候可以返回 304,然后客户端可以继续用旧的数据。
305
请求的资源必须通过代理访问。比如说,我们想请求服务器 A 上新的 iPhone 的信息,但是需要通过代理服务器才能访问,如果直接请求了服务器 A,没有经过代理服务器,这时候服务器 A 就可以返回 305 从而告诉我们应当访问代理服务器。
306
不用了。
307
类似 302,但要求使用原有的请求方式来通过新地址获取资源。
308
类似 301,但要求使用原有的请求方式来通过新地址获取资源。
400
请求出现错误,比如请求头不对等,所有不想明确区分的客户端请求出错都可以返回 400。
401
没有提供认证信息。比如说,请求的时候没有带上 Token 等。
402
为将来的需要所保留的状态码。
403
请求的资源不允许访问。比如说,你使用普通用户的 Token 去请求管理员才能访问的资源。
404
请求的内容不存在。
405
请求的方法不允许使用。比如说,服务器只实现了 PATCH 了局部更新资源,并没有实现 PUT 来替换资源,而我们使用了 PUT,这时候服务器可以返回 405 来告知并没有实现对 PUT 的相关处理。
406
请求的资源并不符合要求。比如说,我们 header 里请求 JSON 格式的数据,但是服务器只有 XML 格式的数据,这时候可以返回 406 告知。
407
类似 401,但是要求必须去同代理服务器进行认证。
408
客户端请求超时。我们想 POST 创建一个用户,虽然建立了连接,但是网络不好,服务器在规定时间内没有得到我们的请求信息,这时候服务器可以返回 408 告诉我们超时了。然后我们可以重新发送请求。
409
请求冲突。比如说,服务器要求不同用户不能重名,服务器已经有了一个名叫小伟的用户,这时候我们又想创建一个名叫小伟的用户,服务器可以返回 409,告诉我们冲突了,也可以在 body 中明确告知是什么冲突了。
410
请求资源曾经存在,但现在不存在了。比如说,我们下载葫芦娃,但是因为版权被删了,下载不了了,这时候服务器返回 410,告诉我们洗洗早点睡。
411
没有提供请求资源的长度。比如说,我们下载葫芦娃,服务器只允许我们分部分下载,我们如果不告诉服务器我们要下载哪部分,服务器就返回 411 警告我们。
412
请求的资源不符合请求头中的 IF-* 的某些条件。比如说,我们下载葫芦娃,然后在请求头告知服务器要 5.20 后更新过的,服务器没有,于是返回了 412。
413
请求体过大。比如说,服务器要求上传文件不能超过 5M,但是我们 POST 了 10M,这时候就返回 413。
414
请求的 URI 太长了。比如说,我们提供了太多的 Query 参数,以至于超过了服务器的限制,这时候可以返回 414。
415
不支持的媒体类型。比如说,我们上传了一张七娃的 GIF 动图,而服务器只允许你上传 PNG 图片,这时候就返回 415。
416
请求的区间无效。比如说,我们分部分下载时请求葫芦娃的 10 分钟到 12 分钟的内容,但是这部葫芦娃只有 1 分钟的内容,这时候就返回 416。
417
预期错误。指服务器没法满足我们在请求头里的 Expect 相关的信息。
418
我是个茶壶。这是一个愚人节的玩笑,这个状态码就是用来搞笑的。
500
服务器错误。没法明确定义的服务器错误都可以返回这个。
501
请求还没有被实现。比如说,我们请求一个接口来自动拒绝项目经理的要求,但是这个接口只是美好的想象,并没有被实现,这时候可以返回 501。
502
网关错误。比如说,我们向服务器 A 请求下载葫芦娃,但是 A 其实只是一个代理服务器,他得向 B 请求葫芦娃,但是不知道为啥 B 不理他或者给他错误,这时候哦可以 A 返回 502 用来表示 B 这家伙傲娇了。
503
服务暂时不可用。比如说,服务器正好在更新代码重启。
504
类似 502,但是这时候是 B 不理 A,超时了 。
505
请求的 HTTP 版本不支持。比如说,现在强行根据 HTTP 1000 来请求。
链接:https://www.zhihu.com/question/58686782/answer/159603453
来源:知乎
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
参考链接
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#cite_note-15
http://racksburg.com/choosing-an-http-status-code/(感谢 @余博伦 大佬的答案)
关于 RESTful API 中 HTTP 状态码的定义的更多相关文章
- 使用ASP.NET Core 3.x 构建 RESTful API - 3.3 状态码、错误/故障、ProblemDetails
HTTP状态码 HTTP状态码会告诉API的消费者以下事情: 请求是否执行成功了 如果请求失败了,那么谁为它负责 HTTP的状态码有很多,但是Web API不一定需要支持所有的状态码.HTTP状态码一 ...
- Restful API 中的错误处理
简介 随着移动开发和前端开发的崛起,越来越多的 Web 后端应用都倾向于实现 Restful API. Restful API 是一个简单易用的前后端分离方案,它只需要对客户端请求进行处理,然后返回结 ...
- 4- vue django restful framework 打造生鲜超市 -restful api 与前端源码介绍
4- vue django restful framework 打造生鲜超市 -restful api 与前端源码介绍 天涯明月笙 关注 2018.02.20 19:23* 字数 762 阅读 135 ...
- 19.在HTTP 1.0中,状态码401的含义是(?);如果返回“找不到文件”的提示,则可用 header 函数,其语句为(?)写出http常见的状态码和含义,至少5个.[完善题目]
状态401代表未被授权,header("Location:www.xxx.php"); 100-199 用于指定客户端应相应的某些动作. 200-299 用于表示请求成功. 300 ...
- 网站建设中HTTP状态码的奥秘
在网络营销中,站长经常会遇到一些HTTP状态码的问题,不懂HTTP状态码那么做SEO优化就无从谈起,下面是脉凌网络对HTTP状态码总结的一览表. 1xx:请求收到,继续处理 2xx:操作成功收到,分析 ...
- php笔记06:http响应中的状态码
首先我们看一个360浏览器中使用开发截图如下: 上面的Status Code: OK (这个就是状态码) 1.状态码主要用于服务器对请求的处理结果,它是一个三位的十进制数.响应状态码分为5类,如下所 ...
- 使用.NET Core在RESTful API中进行路由操作
介绍 当列出REST API的最佳实践时,Routing(路由)总是使它位于堆栈的顶部.今天,在这篇文章中,我们将使用特定于.NET Core的REST(web)API来处理路由概念. 对于新手API ...
- restfull api交互常用状态码
2xx (成功类别) 200 Ok:标准的 HTTP 响应,表示 GET.PUT 或 POST 的处理成功. 201 Created:在创建新实例时,应返回此状态代码.例如,使用 POST 方法创建一 ...
- http协议中的状态码(status code),超文本传输协议状态码
HTTP协议,又叫超文本传输协议. 在项目的开发过程中,前后端交互,这个用的是最多的,在后端给我的的接口调用时,我们往往先查看这个协议的状态码,状态码正常了,才进一步去看我们从后太拿的数据,是否为我们 ...
随机推荐
- yapi部署
官方提供了两种安装方式,由于环境或者权限问题可能会遇到不少麻烦 最简单的安装方式: 第一种方式 npm install -g yapi-cli --registry https://registry. ...
- java实现http请求
String apiUrl = "https://api.seniverse.com/v3/weather/now.json?key=" + key + "&lo ...
- 项目启动,main函数之前的代码执行两次 restartedMain
https://blog.csdn.net/qq_35981283/article/details/78925146
- thinkphp微信浏览器内拉起微信支付
vendor/wxpay/pay.php <?php /* +-----------------------------------+ | 微信支付类 | +------------------ ...
- JS 的骚操作
一.强制类型转换 1.1string强制转换为数字 //可以用*1来转化为数字((实际上是调用.valueOf方法) 然后使用Number.isNaN来判断是否为NaN,或者使用 a !== a 来判 ...
- 一道简单的dp题 --- Greenhouse Effect CodeForces - 269B
题目链接: https://vjudge.net/problem/36696/origin 题目大意: 要求从1到m升序排列,点可以随意移动,问最少需要移动多少次, 思路: 动态规划 可以推出转移方程 ...
- STL复习之 map & vector --- disney HDU 2142
题目链接: https://vjudge.net/problem/40913/origin 大致题意: 这是一道纯模拟题,不多说了. 思路: map模拟,vector辅助 其中用了map的函数: er ...
- HttpHandler和ashx使用Session 出现未初始化异常
原因: HttpHandler和ashx要实现IRequiresSessionState接口才能访问Session信息 接口IRequiresSessionState: 指定目标 HTTP 处理程序需 ...
- CSS入门介绍(一)
css 层叠样式表(英文名:Cascading Style Sheets),主要用于美化网页 1.css的表现形式 1.1 行内样式(内嵌样式) 写在标签内的样式,写在标签的开始部分的内部,style ...
- Node.js_express_临时会话对象 session
临时会话对象 session 也是用来 解决 http 无状态协议的问题(无法区分多次请求是否发送自同一客户端) npm install express-session npm install con ...