深入理解RESTful API设计

RESTful API 全称 REpresentational State Transfer (表现层状态转化) 服务器上的文本,图片,网页,视频等都是资源(Resources), 通常使用一个唯一的URI(统一资源定位符)来表示. “资源”具体呈现出来的形式,叫做它的”表现层”(Representation)

状态转换

访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。

互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生”状态转化”(State Transfer)。而这种转化是建立在表现层之上的,所以就是”表现层状态转化”。

一般网址后面会有”.html”后缀,这不是必要的, 这属于”表现层”范畴, URI应该只代表”资源”的位置。它的具体表现形式,应该在HTTP请求的头信息中用AcceptContent-Type字段指定,这两个字段才是对”表现层”的描述.

客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面操作方式的动词:GET、POST、PUT、PATCH、DELETE 当然还有一些不经常使用的

截取自Postman


* GET: 获取某个资源,GET操作应该是幂等(idempotence)的,且无副作用。
* POST: 创建一个新的资源。
* PUT: 替换某个已有的资源。PUT操作虽然有副作用,但其应该是幂等的。
* PATCH(RFC5789): 修改某个已有的资源。
* DELETE:删除某个资源。DELETE操作有副作用,但也是幂等的。

这里说明一下PUT和PATCH的区别:
    假设修改一个用户信息(name, age, height, weight)
    1. 使用PUT:
         只传入了name, age(不完全信息)的话, 则height和weight会被替换为空, 是一个完全覆盖的思想
    2. 使用PATCH:
         可以传入部分参数或全部参数, 但没有传入的参数是不会被修改的.

REST四个基本原则:

1.使用HTTP动词:GET POST PUT PATCH DELETE等; 2.无状态连接,服务器端不应保存过多上下文状态,即每个请求都是独立的; 3.为每个资源设置唯一的URI; 4.通过XML或JSON进行数据传递;

实现上述原则的架构即可称为RESTful架构。

1.互联网环境下,任何应用的架构和API可以被快速理解; 2.分布式环境下,任何请求都可以被发送到任意服务器; 3.异构环境下,任何资源的访问和使用方式都统一;

状态码

关于状态码推荐阅读: http://clojure-liberator.github.io/liberator/doc/decisions.html

请求数据验证(反爬虫)

  1. Request headers是否合法:如果出现了某些不该有的头,或者某些必须包含的头没有出现或者内容不合法,根据其错误类型一律返回4xx。比如说你的API需要某个特殊的私有头(e.g. X-Request-ID),那么凡是没有这个头的请求一律拒绝。这可以防止各类漫无目的的webot或crawler的请求,节省服务器的开销。
  2. Request URI和Request body是否合法:如果请求带有了不该有的数据,或者某些必须包含的数据没有出现或内容不合法,一律返回4xx。比如说,API只允许querystring中含有query,那么”?sort=desc”这样的请求需要直接被拒绝。有不少攻击会在querystring和request body里做文章,最好的对应策略是,过滤所有含有不该出现的数据的请求。

参考

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏IT技术精选文摘

基于Netty实现海量接入的推送服务技术要点

25650
来自专栏北京马哥教育

如何利用多核CPU来加速你的Linux命令 — awk, sed, bzip2, grep, wc等

如何利用多核CPU来加速你的Linux命令 — awk, sed, bzip2, grep, wc等 你是否曾经有过要计算一个非常大的数据(几百GB)的需求?或...

34590
来自专栏服务端技术杂谈

分布式系统中所说的幂等性

大型网站应用架构中,越来越多的SOA或Restful的web api的流行归功于http协议。 幂等性定义 Http协议涉及到一种重要性质:幂等性。 Http方...

32140
来自专栏风火数据

高级Java研发师在解决大数据问题上的一些技巧

众所周知, Java 在处理数据量比较大的时候,加载到内存必然会导致内存溢出,而在一些数据处理中我们不得不去处理海量数据,在做数据处理中,我们常见的手段是分解,...

15320
来自专栏Java架构沉思录

基于Netty的百万级推送服务设计要点

最近很多从事移动互联网和物联网开发的同学给我发邮件或者微博私信我,咨询推送服务相关的问题。问题五花八门,在帮助大家答疑解惑的过程中,我也对问题进行了总结,大概可...

35020
来自专栏jouypub

十分钟检查Linux服务器性能

你是否遇到过:服务器负载飙升;服务被已经挂起,接口长时间没响应;服务刚重启,过一会又无法访问等等。这时下面这几条命令就可以尽快的帮你快速定位问题,找出问题的根源

40210
来自专栏用户2442861的专栏

Java NIO浅析

作者:美团点评技术团队 链接:https://zhuanlan.zhihu.com/p/23488863 来源:知乎 著作权归作者所有。商业转载请联系作者...

20640
来自专栏应用案例

性能测试之gatling详解

大家接触过形形色色的压力测试工具,例如lr,jmeter各有各的优点,那么最近在做接口测试中涉及到压力测试,小弟就看到一个好用的工具俗称“加特林”英文Gatli...

40760
来自专栏月色的自留地

在Mac上使用远程X11应用

85960
来自专栏游戏杂谈

liunx下查看服务器硬件信息

今天安装了9台Linux服务器,型号完全不一样(有DELL、HP和IBM服务器),又懒得去对清单,如何在Linux下cpu的个数和核数呢?另外,nginx的cp...

1.1K20

扫码关注云+社区

领取腾讯云代金券