zoukankan      html  css  js  c++  java
  • RESTFul API

    1、常用的Http状态码:

    状态码 状态 具体描述
    200  OK 客户端请求成功
    201 Created 已创建
    202 Accepted 已接受。已经接受请求,但未处理完成
    203 Non-Authoritative Information 非授权信息。请求成功。但返回的meta信息不在原始的服务器,而是一个副本
    204 No Content 无内容。服务器成功处理,但未返回内容。在未更新网页的情况下,可确保浏览器继续显示当前文档
    205 Reset Content 重置内容。服务器处理成功,用户终端(例如:浏览器)应重置文档视图。可通过此返回码清除浏览器的表单域
    206 Partial Content 部分内容。服务器成功处理了部分GET请求
         
    300 Multiple Choices 多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择
    301 Moved Permanently 永久移动。请求的资源已被永久的移动到新URI,返回信息会包括新的URI,浏览器会自动定向到新URI。今后任何新的请求都应使用新的URI代替
    302 Found 临时移动。与301类似。但资源只是临时被移动。客户端应继续使用原有URI
    303 See Other 查看其它地址。与301类似。使用GET和POST请求查看
    304 Not Modified 未修改。所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。客户端通常会缓存访问过的资源,通过提供一个头信息指出客户端希望只返回在指定日期之后修改的资源
    305 Use Proxy 使用代理。所请求的资源必须通过代理访问
    306 Unused 已经被废弃的HTTP状态码
    307 Temporary Redirect 临时重定向。与302类似。使用GET请求重定向
         
    400  Bad Request 客户端请求有语法错误,不能被服务器所理解
    401  Unauthorized 服务器收到请求,但是拒绝提供服务
    402 Payment Required 保留,将来使用
    403 Forbidden 服务器理解请求客户端的请求,但是拒绝执行此请求
    404  Not Found 请求资源不存在
    405 Method Not Allowed 客户端请求中的方法被禁止
    406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求
    407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权
    408 Request Time-out 服务器等待客户端发送的请求时间过长,超时
    409 Conflict 服务器完成客户端的 PUT 请求时可能返回此代码,服务器处理请求时发生了冲突
    410 Gone 客户端请求的资源已经不存在。410不同于404,如果资源以前有现在被永久删除了可使用410代码,网站设计人员可通过301代码指定资源的新位置
    411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息
    412 Precondition Failed 客户端请求信息的先决条件错误
    413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息
    414 Request-URI Too Large 请求的URI过长(URI通常为网址),服务器无法处理
    415 Unsupported Media Type 服务器无法处理请求附带的媒体格式
    416 Requested range not satisfiable 客户端请求的范围无效
    417 Expectation Failed 服务器无法满足Expect的请求头信息
         
    500  Internal Server Error 服务器发生不可预期的错误
    501  Not Implemented 服务器不支持请求的功能,无法完成请求
    502 Bad Gateway 作为网关或者代理工作的服务器尝试执行请求时,从远程服务器接收到了一个无效的响应
    503  Server Unavailable 服务器不能处理当前客户端的请求,一般是当服务器的性能达到瓶颈之后就不能处理新进来的请求
    504  Gateway Time-out 充当网关或代理的服务器,未及时从远端服务器获取请求
    505  HTTP Version not supported 服务器不支持请求的HTTP协议的版本,无法完成处理

    更多状态码:https://www.cnblogs.com/vichin/p/12182501.html

    2、根据以下几个方面来设计RESTFful API

    资源路径(URI)、HTTP动词、过滤信息、状态码、错误处理、返回结果。

    资源路径:在URI中一般不涉及动词。比如获取用户信息可以使用https://www.cnblogs.com/v1/user,该请求为get请求,如果要删除则使用delete。

    HTTP动词:

        GET:从服务器取出资源。 /user/ID获取指定用户的信息。

        POST:在服务器新建一个资源。/user 新建一个用户。

        PUT:在服务器更新资源(客户端提供改变后的完整资源)。/user/ID 更新指定用户的信息。

        DELETE:从服务器删除资源。 user/ID 删除指定用户的信息。

    过滤信息:如果数据太多,服务器端不可能一次性将所有数据都返回给客户端,API应该提供参数,过滤返回结果。?page=2&per_page=100#

    状态码:服务器向用户返回的状态码和提示信息,使用标准的HTTP状态码。

        200 OK 客户端请求成功,服务器端成功返回用户请求的数据。(该操作是幂等的)    

        201 CREATED 新建或修改数据成功。

        204 NO CONTENT 删除数据成功。

        400 BAD REQUEST 用户发出的请求有错误。(该操作是幂等的)

        401 Unauthorized 表示该用户没有认证,无法进行当前操作。

        403 Forbidden 表示用户访问是被禁止的。

        422 Unprocesable Entity 当创建一个对象时,发生了一个验证错误。(账号或密码错误等……)

        500 INTERNAL SERVER ERROR服务器发生错误,用户将无法判断发出的请求是否成功。

    错误处理:如果状态码是4XX或者是5XX,应该向用户返回出错信息,一般来说,返回的信息中将error作为键名,出错信息作为键值即可。

        例如:{"error":"参数错误"}

    返回结果:针对不同操作,服务器向用户返回的结果应该符合以下规范;

        GET /users :返回资源对象的列表(数组)。

        GET /users/id  :返回单个资源对象。

        POST /users  :返回新生成的资源对象。

        PUT  /users/id  :返回被更新的完整的资源对象。

        DELETE  /users/id  :返回一个空文档(此时的状态码是204)。

  • 相关阅读:
    tf-idf 解释
    maven 下载依赖失败
    eclipse 快捷键
    线程数 QPS
    resin conf
    静态成员 生命周期
    SuperMap 9D 实时数据服务学习笔记
    SuperMap iServer 在Linux 部署中问题总结
    在SuperMap iDesktop中如何快速追加记录行?
    Landsat8 卫星数据下载
  • 原文地址:https://www.cnblogs.com/vichin/p/12542035.html
Copyright © 2011-2022 走看看