最简单但最通用的response键名规范

前言

现在response的键名可谓五花八门,甚至每个后端程序员都有一套自己习惯的键名规范,虽然说,不能说谁对谁错,但是这么乱下去终究不是办法,我只说我个人在用的一套方法。

code或者叫status

用哪个都成,通常用code。值采用整数型,取值范围如下,通常够用,当然你可以增加更多的值:

  • 200 OK – 对成功的GET、PUT、PATCH或DELETE操作进行响应。也可以被用在不创建新资源的POST操作上
  • 201 Created – 对创建新资源的POST操作进行响应。应该带着指向新资源地址的Location header)
  • 204 No Content – 对不会返回响应体的成功请求进行响应(比如DELETE请求)
  • 304 Not Modified – "HTTP缓存"header生效的时候用
  • 400 Bad Request – 请求异常,比如请求中的body无法解析
  • 401 Unauthorized – 没有进行认证或者认证非法。当API通过浏览器访问的时候,可以用来弹出一个认证对话框
  • 403 Forbidden – 当认证成功,但是认证过的用户没有访问资源的权限
  • 404 Not Found – 当一个不存在的资源被请求
  • 405 Method Not Allowed – 所请求的HTTP方法不允许当前认证用户访问
  • 410 Gone – 表示当前请求的资源不再可用。当调用老版本API的时候很有用
  • 415 Unsupported Media Type – 如果请求中的内容类型是错误的
  • 422 Unprocessable Entity – 用来表示校验错误
  • 429 Too Many Requests – 由于请求频次达到上限而被拒绝访问

另外,可以用-1表示服务器代码执行错误,因为服务器代码执行出错需要根据抛出的错误来返回结果,跟上述的错误不是一个概念。

message

message用来描述response的状态信息,也就是Not Found这一类的东西,记住,这个message是给前端程序员看的,所以不应该以message为分支判断依据来写后续代码,而是应该以code为分支判断依据。

这个message的内容要精练,但是要把事情描述清楚,毕竟是给前端程序员阅读的东西,比如上面的Not Found,如果很明确知道是哪个资源未找到,那么这样写就OK了,极少数情况下,如果程序员看不出什么资源未找到,则需要写全,毕竟,只看code: 404我们就已经知道是某个资源未找到,所以,你要给出更具体的信息,比如Username Not Found之类的。

result

result就是响应的具体内容了,虽然流行的更多的实践是使用data,但是我反对,因为data字眼使用的太泛滥了,经过封装的response往往会出现使用res.data.data.id来获取id,两个data连贯在一起,是不是很2?所以,放心的用result吧。

通常,如果请求有问题,当然不可能返回他想要的数据,此时不设result即可。

同样的,不需要返回result,也无需设result。

举例

  1. 当认证成功,但是认证过的用户没有访问资源的权限
{
  code: 403,
  message: 'Forbidden'
}
  1. 正常请求成功
{
  code: 200,
  message: 'OK'
  result: {
    id: 44,
    username: 'Jordan',
    city: 'New York'
  }
}

分支逻辑写法

既然有多种可能的code,那么必然要做多种分支考虑,举个例子:

if (res.code === 200) {
  ...
} else if (res.code === 403) {
  ...
}
...

或者switch ... case ... 也可以。

就这么简单。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 下载安装搭建环境 可以选npm安装,或者简单下载一个开发版的vue.js文件 浏览器打开加载有vue的文档时,控制...
    冥冥2017阅读 6,081评论 0 42
  • 1.安装 可以简单地在页面引入Vue.js作为独立版本,Vue即被注册为全局变量,可以在页面使用了。 如果希望搭建...
    Awey阅读 11,087评论 4 129
  • 这篇笔记主要包含 Vue 2 不同于 Vue 1 或者特有的内容,还有我对于 Vue 1.0 印象不深的内容。关于...
    云之外阅读 5,074评论 0 29
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,132评论 25 708
  • 我也列出一篇清单! 1,我要有一个自己喜爱的事业。 2,我要为我做的事情不感到后悔。 3,有着自己独立的思想。 4...
    奇葩的默子阅读 163评论 0 0