restful-API：错误分类处理机制和常用返回http状态码

1 需求

REST 目前并没有一个普遍接受的标准，因此开发者需要自行决定 API 的设计，其中一项决策就是错误处理。

比如我们是否应该使用 HTTP 状态码来标识错误？如何返回表单验证的结果等等。

 

2 错误类型

错误可以分为两种类型：全局错误和本地错误。

全局错误（应由 Web 框架捕获）：

（1）请求了一个不存在的 API—》

（2）无权请求这个 API—〉auth

（3）数据库连接失败—>database try except

（4）其他一些没有预期到的、会终止程序运行的服务端错误

 

本地错误（和 API 密切相关）：

（1）请求参数的字段和类型，表单验证,

（2）唯一性检查

（3）其他可预期的错误处理

我们需要编写特定代码来捕获这类错误，并抛出一个包含提示信息的全局异常，供 Web 框架捕获并返回给客户端。

 

Flask 框架就提供了此类全局异常处理机制：

使用 Flask-RESTful 来处理验证的另一个好处就是没有必要单独地处理类似 HTTP 400 错误，Flask-RESTful 会来处理这些。

 

自动处理成json，并自定义状态码

return { 'task': ‘hello world' }, 201

 

3 返回格式

 

{
Code: 200, 
Message: 'Successful', 
token: '38ce6474a370c3fe84ddf92403bec204cfcbe07b',
data:{ key1: value1}
}

 

{
Status: 1, //数据状态
Code: 200, 
Message: 'Successful', 
ClientTime: 1473765898, 
ServerTime: 1473765935, 
token: '38ce6474a370c3fe84ddf92403bec204cfcbe07b',
data:{ 
    key1: value1,
    key2: value2,
    key3: {
    [
        name: '小明',
        sex: 1,
    ],[
        name: '小华',
        sex: 1,
    ],[
        name: '小刚',
        sex: 1,
    ]}
}
}

4 常用返回状态

GET HTTP/1.1 200 OK  正确返回
POST   HTTP/1.1 201  Created 已创建
DELETE HTTP/1.1 204 NO CONTENT  没有返回体
 
POST HTTP/1.1 400 BadRequest 前端请求失败，方式参数不对
POST HTTP/1.1 401 No Auth 没有权限
DELETE HTTP/1.1 403 Forbidden 禁止访问
POST   HTTP/1.1 404  Not Found 没有资源页面
PATCH  HTTP/1.1 422 UnprocessableEntity（不能处理实体，图片文件等）
 
GET  HTTP/1.1 500 InternalError 服务器内部错误

200 和204 的区别

* 如果导航到的URL返回了一个没有响应体的HTTP/200响应，则页面将会显示一个空白文档(就是一片白色)，页面的URL地址也会变成新指定的URL。

* 如果服务器返回的是一个HTTP/204响应，当前页面不会有任何变化，就好像根本没有进行导航操作一样，页面的URL地址也保持不变。

 

5 其他需要的返回状态

1xx：信息响应类，表示接收到请求并且继续处理
2xx：处理成功响应类，表示动作被成功接收、理解和接受
3xx：重定向响应类，为了完成指定的动作，必须接受进一步处理
4xx：客户端错误，客户请求包含语法错误或者是不能正确执行
5xx：服务端错误，服务器不能正确执行一个正确的请求

100——客户必须继续发出请求
101——客户要求服务器根据请求转换HTTP协议版本

200——交易成功
201——提示知道新文件的URL
202——接受和处理、但处理未完成
203——返回信息不确定或不完整
204——请求收到，但返回信息为空
205——服务器完成了请求，用户代理必须复位当前已经浏览过的文件
206——服务器已经完成了部分用户的GET请求

300——请求的资源可在多处得到
301——删除请求数据
302——在其他地址发现了请求数据
303——建议客户访问其他URL或访问方式
304——客户端已经执行了GET，但文件未变化
305——请求的资源必须从服务器指定的地址得到
306——前一版本HTTP中使用的代码，现行版本中不再使用
307——申明请求的资源临时性删除

400——错误请求，如语法错误
401——请求授权失败
402——保留有效ChargeTo头响应
403——请求不允许
404——没有发现文件、查询或URl
405——用户在Request-Line字段定义的方法不允许
406——根据用户发送的Accept拖，请求资源不可访问
407——类似401，用户必须首先在代理服务器上得到授权
408——客户端没有在用户指定的饿时间内完成请求
409——对当前资源状态，请求不能完成
410——服务器上不再有此资源且无进一步的参考地址
411——服务器拒绝用户定义的Content-Length属性请求
412——一个或多个请求头字段在当前请求中错误
413——请求的资源大于服务器允许的大小
414——请求的资源URL长于服务器允许的长度
415——请求资源不支持请求项目格式
416——请求中包含Range请求头字段，在当前请求资源范围内没有range指示值，请求也不包含If-Range请求头字段
417——服务器不满足请求Expect头字段指定的期望值，如果是代理服务器，可能是下一级服务器不能满足请求

500——服务器产生内部错误
501——服务器不支持请求的函数
502——服务器暂时不可用，有时是为了防止发生系统过载
503——服务器过载或暂停维修
504——关口过载，服务器使用另一个关口或服务来响应用户，等待时间设定值较长
505——服务器不支持或拒绝支请求头中指定的HTTP版本