现在的项目api想用restful风格,然后目前的api接口返回规范:所有成功接口返回{status:200,msg:'',data:{}},出错接口返回{status:403,msg:'',data:{}},也就是只有200和403两种状态,我感觉不太对劲,搜了下网上的
200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务) 204 NO CONTENT - [DELETE]:用户删除数据成功。 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
我是否是要按照这样的规范根据不同的情况去返回状态码?比如get请求成功返回200,post请求成功返回201?而不是只要成功就返回200?话说这些状态码真的是写在返回值里吗?不是应该http协议里自动判定的吗?或者在返回的header里修改?这里很迷糊,希望大神解惑!
有两种方法
1.status_code全部200,响应体如下:
成功
失败
2.根据不同的status_code处理(推荐)
成功(2xx)
,直接返回数据,不用额外包装失败(4xx,5xx)
,返回errcode和errmsg{status:200,msg:'',data:{}}
这个应该是你API里自己写的返回结果吧,比如servlet里返回一个json字符串包含这3个字段。也就是说只有你的api返回成功时前端才能读到这些信息。如果请求失败是读不到的,你可以前端请求一个错误的url试试看其实如果规范的话 应该是要这么返回的
header('HTTP/1.0 401 Unauthorized');
header('HTTP/1.0 403 Forbidden');
不过实际情况下,很多人不会这么规范。
连GET请求和POST请求都在混用,何谈规范呢
本来是应该按规范来的,但是国内电信运营商可能会劫持跳转。比如你返回 404,运营商可能给你跳到他们自己的导航网站,那就尴尬了。
你的接口返回数据 和http响应是两个东西
接口返回的code是内定的 想怎么定就怎么定
而你查的资料那是http响应的状态码 和你接口返回无关
业务错误代码 4xx
成功200 - 204
系统错误 5xx