接口设计和响应码参考

2017-03-23  本文已影响356人  never615

项目响应参照http定义的响应码,成功条件下直接返回请求内容.无内容返回204.所有失败直接抛出异常,系统在使用统一的异常处理,对于json请求返回json,非json返回对应的错误页面.

在项目中,发生的任何需要返回非200开头的响应的时候,均直接抛出一个http异常.项目中有统一的异常处理中心,异常处理中心作统一化处理,比如最基本的,json请求响应json,非json请求响应页面.需要根据自己的业务定制各种异常,比如资源类错误ResourceException(继承自HttpException).然后StoreResourceFailedException继承自ResourceException.设计各种异常,在业务代码中需要返回错误的时候,直接throw一个异常就好了,十分方便清晰.

响应

响应使用json,遵照http标准.

成功

200(包括其他200开头的响应码)时直接返回请求结果;
204,表示无内容的成功响应,会执行success回调,但是没有data数据.

失败

发生错误全部使用http异常响应.
错误信息包含在响应体中的error字段中.
(如ajax请求获取:XMLHttpRequest.responseJSON.error).

关于 422 响应码
对于422验证失败的错误,在一些情况下响应体中是不返回error字段的.
响应返回的是key-value形式的键值对,key表示错误字段,value表示错误原因.比如返回:"["name"=>"名称 不能为空","mobile"=>"手机号 不能为空"]"

例子

在ajax请求中的error中处理错误:

error: function (XMLHttpRequest, textStatus, errorThrown) {
        var msg=""; 
        if(XMLHttpRequest.status == 401){
              //未授权,刨除编码错误导致的401.
              //对于微信端可能是token失效,需要通过授权中心重新获得token
        }
        if (XMLHttpRequest.responseJSON && XMLHttpRequest.responseJSON.error) {
            //后台有专门返回的错误信息的情况
            msg += XMLHttpRequest.responseJSON.error;
        } else {
            //如果没有响应中没有error
            if (XMLHttpRequest.status == 422) {
                //422 响应可能返回数组形式错误信息.如:["name"=>"名称 不能为空","mobile"=>"手机号 不能为空"]
                var erroMsg = JSON.parse(XMLHttpRequest.responseText);
                $.each(erroMsg, function (k, v) {
                    msg += v[0] + "\\n";
                });
            } else {
                //其他
                msg += XMLHttpRequest.statusText + ":" + XMLHttpRequest.status;
            }
        }
        //拿着msg做出提示
}

详细介绍

响应码由三位十进制数字组成，它们出现在由HTTP服务器发送的响应的第一行。

响应码分五种类型，由它们的第一位数字表示：

1xx：信息，请求收到，继续处理 
2xx：成功，行为被成功地接受、理解和采纳 
3xx：重定向，为了完成请求，必须进一步执行的动作 
4xx：客户端错误，请求包含语法错误或者请求无法实现 
5xx：服务器错误，服务器不能实现一种明显无效的请求

    100 => 'Continue', //继续 
    101 => 'Switching Protocols', //分组交换协议 
    102 => 'Processing',             // RFC2518
    200 => 'OK',
    201 => 'Created',                 //被创建 
    202 => 'Accepted',              //被采纳 
    203 => 'Non-Authoritative Information',  //非授权信息 
    204 => 'No Content',   //无内容 
    205 => 'Reset Content',    //重置内容 
    206 => 'Partial Content',  //部分内容 
    207 => 'Multi-Status',          // RFC4918
    208 => 'Already Reported',      // RFC5842
    226 => 'IM Used',               // RFC3229
    300 => 'Multiple Choices',  //多选项 
    301 => 'Moved Permanently',  //永久地传送  
    302 => 'Found',   //找到 
    303 => 'See Other',   //参见其他 
    304 => 'Not Modified',   //未改动 
    305 => 'Use Proxy',    //使用代理 
    307 => 'Temporary Redirect',  //暂时重定向 
    308 => 'Permanent Redirect',    // RFC7238
    400 => 'Bad Request',   //错误请求 
    401 => 'Unauthorized',   //未授权 
    402 => 'Payment Required',  //要求付费 
    403 => 'Forbidden',   //禁止 
    404 => 'Not Found',   //未找到 
    405 => 'Method Not Allowed',   //不允许的方法 
    406 => 'Not Acceptable',   //不被采纳 
    407 => 'Proxy Authentication Required',   //要求代理授权 
    408 => 'Request Timeout',   //请求超时 
    409 => 'Conflict',   //冲突 
    410 => 'Gone',    //过期的 
    411 => 'Length Required',   //要求的长度 
    412 => 'Precondition Failed',    //前提不成立 
    413 => 'Payload Too Large',    //请求实例太大 
    414 => 'URI Too Long',    //请求URI太大 
    415 => 'Unsupported Media Type',   //不支持的媒体类型 
    416 => 'Range Not Satisfiable',     //无法满足的请求范围 
    417 => 'Expectation Failed',     //失败的预期 
    418 => 'I\'m a teapot',                                               // RFC2324
    421 => 'Misdirected Request',                                         // RFC7540
    422 => 'Unprocessable Entity',                                        // RFC4918,资源错误
    423 => 'Locked',                                                      // RFC4918
    424 => 'Failed Dependency',                                           // RFC4918
    425 => 'Reserved for WebDAV advanced collections expired proposal',   // RFC2817
    426 => 'Upgrade Required',                                            // RFC2817
    428 => 'Precondition Required',                                       // RFC6585
    429 => 'Too Many Requests',                                           // RFC6585
    431 => 'Request Header Fields Too Large',                             // RFC6585
    451 => 'Unavailable For Legal Reasons',                               // RFC7725
    500 => 'Internal Server Error',   //内部服务器错误 
    501 => 'Not Implemented',   //未被使用 
    502 => 'Bad Gateway',     //网关错误 
    503 => 'Service Unavailable',   //不可用的服务/维护
    504 => 'Gateway Timeout',   //网关超时 
    505 => 'HTTP Version Not Supported',   //HTTP版本未被支持
    506 => 'Variant Also Negotiates (Experimental)',                      // RFC2295
    507 => 'Insufficient Storage',                                        // RFC4918
    508 => 'Loop Detected',                                               // RFC5842
    510 => 'Not Extended',                                                // RFC2774
    511 => 'Network Authentication Required',                             // RFC6585

部分响应码详细介绍

了解更多请参考:http响应码

上一篇 下一篇

猜你喜欢

热点阅读