美文网首页
restful风格接口相关总结

restful风格接口相关总结

作者: 没个性的七秒鱼 | 来源:发表于2017-09-20 11:56 被阅读0次

    有关restful概念请看阮一峰的文章,http://www.ruanyifeng.com/blog/2014/05/restful_api.html
    这里总结一下:
    什么是RESTful架构:
    (1)每一个URI代表一种资源;
    (2)客户端和服务器之间,传递这种资源的某种表现层;
    (3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。
    HTTP动词:
    GET(SELECT):从服务器取出资源(一项或多项)。
    POST(CREATE):在服务器新建一个资源。
    PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
    PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性),这个很少用。
    DELETE(DELETE):从服务器删除资源。

    HTTP 状态代码 (这里是参考RESTful API 设计最佳实践,http://www.oschina.net/translate/best-practices-for-a-pragmatic-restful-api?lang=chs&page=4#
    HTTP定义了一套可以从API返回的有意义的状态代码。 这些代码能够用来帮助API使用者对不同的响应做出相应处理。我已经把你必然会用到的那些列成了一个简短的清单:
    200 OK (成功) - 对一次成功的GET, PUT, PATCH 或 DELETE的响应。也能够用于一次未产生创建活动的POST
    201 Created (已创建) - 对一次导致创建活动的POST的响应。 同时结合使用一个位置头信息指向新资源的位置- Response to a POST that results in a creation. Should be combined with a Location header pointing to the location of the new resource
    204 No Content (没有内容) - 对一次没有返回主体信息(像一次DELETE请求)的请求的响应
    304 Not Modified (未修改) - 当使用HTTP缓存头信息时使用304
    400 Bad Request (错误的请求) - 请求是畸形的, 比如无法解析请求体
    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 (请求过多) - 当请求由于访问速率限制而被拒绝时

    相关文章

      网友评论

          本文标题:restful风格接口相关总结

          本文链接:https://www.haomeiwen.com/subject/fvansxtx.html