怎样更好的设计你的REST API之基于REST架构的Web Service设计及REST框架实现
一、REST
含状态传输(英文:Representational State Transfer,简称REST)是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。
眼下在三种主流的Web服务实现方案中。由于REST模式与复杂的SOAP和XML-RPC相比更加简洁。越来越多的web服务開始採用REST风格设计和实现。
比如:Amazon.com提供接近REST风格的Web服务进行图书查找;雅虎提供的Web服务也是REST风格的。
二、REST的架构设计
REST(Representational State Transfer)是一种轻量级的Web Service架构风格,事实上现和操作明显比SOAP和XML-RPC更为简洁,能够全然通过HTTP协议实现,还能够利用缓存Cache来提高响应速度。性能、效率和易用性上都优于SOAP协议。
REST架构遵循了CRUD原则,CRUD原则对于资源仅仅须要四种行为:Create(创建)、Read(读取)、Update(更新)和Delete(删除)就能够完毕对其操作和处理。这四个操作是一种原子操作。即一种无法再分的操作。通过它们能够构造复杂的操作过程,正如数学上四则运算是数字的最主要的运算一样。
REST架构让人们真正理解我们的网络协议HTTP本来面貌,对资源的操作包含获取、创建、改动和删除资源的操作正好相应HTTP协议提供的GET、POST、PUT和DELETE方法,因此REST把HTTP对一个URL资源的操作限制在GET、POST、PUT和DELETE这四个之内。
这样的针对网络应用的设计和开发方式。能够减少开发的复杂性。提高系统的可伸缩性。
三、REST的设计准则
REST架构是针对Web应用而设计的,其目的是为了减少开发的复杂性,提高系统的可伸缩性。REST提出了例如以下设计准则:
l 网络上的全部事物都被抽象为资源(resource)
l 每一个资源相应一个唯一的资源标识符(resource identifier)
l 通过通用的连接器接口(generic connector interface)对资源进行操作
l 对资源的各种操作不会改变资源标识符
l 全部的操作都是无状态的(stateless)
四、要点及标准
须要注意的是。REST是设计风格而不是标准。
REST通常基于使用HTTP。URI,和XML以及HTML这些现有的广泛流行的协议和标准。
l 资源是由URI来指定。
l 对资源的操作包含获取、创建、改动和删除资源,这些操作正好相应HTTP协议提供的GET、POST、PUT和DELETE方法。
l 通过操作资源的表现形式来操作资源。
l 资源的表现形式则是XML或者HTML。取决于读者是机器还是人。是消费web服务的客户软件还是web浏览器。
当然也能够是不论什么其它的格式。
五、REST的要求
l client和server结构
l 连接协议具有无状态性
l 可以利用Cache机制增进性能
l 层次化的系统
l 随需代码 - Javascript (可选)
六、关于状态
应该注意差别应用的状态和连接协议的状态。HTTP连接是无状态的(也就是不记录每一个连接的信息),而REST传输会包括应用的全部状态信息,因此能够大幅减少对HTTP连接的反复请求资源消耗。
七、含状态传输的 Web 服务
含状态传输的 Web 服务(也称为 RESTful Web API)是一个使用HTTP并遵循REST原则的Web服务。
它从下面三个方面资源进行定义:
l 直观简短的资源地址:URI,比方:http://example.com/resources/。
l 传输的资源:Web服务接受与返回的互联网媒体类型,比方:JSON。XML ,YAML 等。
l 对资源的操作:Web服务在该资源上所支持的一系列请求方法(比方:POST,GET,PUT或DELETE)。
下表列出了在实现 含状态传输的 Web 服务时HTTP请求方法的典型用途。
HTTP 请求方法在RESTful Web 服务中的典型应用 |
||||
资源 |
GET |
PUT |
POST |
DELETE |
一组资源的URI。比方http://example.com/resources/ |
列出 URI,以及该资源组中每一个资源的具体信息(后者可选)。 |
使用给定的一组资源替换当前整组资源。 |
在本组资源中创建/追加一个新的资源。 该操作往往返回新资源的URL。 |
删除 整组资源。 |
单个资源的URI,比方http://example.com/resources/142 |
获取 指定的资源的具体信息。格式能够自选一个合适的网络媒体类型(比方:XML、JSON等) |
替换/创建 指定的资源。 并将其追加到对应的资源组中。 |
把指定的资源当做一个资源组,并在其下创建/追加一个新的元素,使其隶属于当前资源。 |
删除 指定的元素。 |
PUT 和 DELETE 方法是幂等方法。GET方法是安全方法 (不会对server端有改动,因此當然也是幂等的)。
不像基于SOAP的Web服务。RESTful Web服务并没有的“正式”标准[2]。 这是由于REST是一种架构。而SOAP仅仅是一个协议。
尽管REST不是一个标准,但在实现RESTful Web服务时能够使用其它各种标准(比方HTTP,URL。XML。PNG等)。
八、实现举例
比如。一个简单的网络商店应用,
列举全部商品,
GET http://www.store.com/products
呈現某一件商品,
GET http://www.store.com/product/12345
下单购买,
POST http://www.store.com/order
<purchase-order>
<item> ... </item>
</purchase-order>
九、REST的长处
l 可更高效利用缓存来提高响应速度
l 通讯本身的无状态性能够让不同的server的处理一系列请求中的不同请求,提高server的扩展性
l 浏览器就可以作为client,简化软件需求
l 相对于其它叠加在HTTP协议之上的机制,REST的软件依赖性更小
l 不须要额外的资源发现机制
l 在软件技术演进中的长期的兼容性更好
十、个人总结
l REST架构仅仅是一种思想,并没有限定不论什么技术,不论什么语言。
l REST的本质就是HTTP调用,用于减少各个应用之间的耦合度。
l 良好的REST 架构。应该有统一的表示方式和数据格式,可以有效的把各种资源组织起来,并可以进行有效的控制。
怎样更好的设计你的REST API之基于REST架构的Web Service设计及REST框架实现的更多相关文章
- 基于REST架构的Web Service设计
来自: http://www.williamlong.info/archives/1728.html 先前我曾经介绍过利用Apache Axis实现基于SOAP的Web Service实现技术和相关代 ...
- (转)基于REST架构的Web Service设计
原文出处:http://www.williamlong.info/archives/1728.html ------------------------------------------------ ...
- 如何设计一个优秀的API(转载)
最近在整理框架的一些 API,觉得很有必要总结一下 API 兼容性的设计.下图是我自己当下的一些总结,慢慢维护: 网上搜索了一下,一个多月前,“标点符”已经发布了下面这篇文章,觉得写得非常不错,转载于 ...
- 如何设计一个优秀的API(转)
到目前为止,已经负责API接近两年了,这两年中发现现有的API存在的问题越来越多,但很多API一旦发布后就不再能修改了,即时升级和维护是必须的.一旦API发生变化,就可能对相关的调用者带来巨大的代价, ...
- 基于MVC4+EasyUI的Web开发框架形成之旅--MVC控制器的设计
自从上篇<基于MVC4+EasyUI的Web开发框架形成之旅--总体介绍>总体性的概括,得到很多同行的关注和支持,不过上一篇主要是介绍一个总体的界面效果和思路,本系列的文章将逐步介绍其中的 ...
- 如何设计一个优秀的API
如何设计一个优秀的API - 文章 - 伯乐在线 http://blog.jobbole.com/42317/ 如何设计一个优秀的API - 标点符 https://www.biaodianfu.co ...
- JDBC中DAO+service设计思想
一.DAO设计思想 a) Data access Object(数据访问对象):前人总结出的一种固定模式的设计思想. 高可读性. 高复用性. 高扩展性. b) JDBC代码实现的增删改查操作是有复用需 ...
- 实战使用Axure设计App,使用WebStorm开发(3) – 构建页面架构
系列文章 实战使用Axure设计App,使用WebStorm开发(1) – 用Axure描述需求 实战使用Axure设计App,使用WebStorm开发(2) – 创建 Ionic 项目 实战使 ...
- 基于“事件”驱动的领域驱动设计(DDD)框架分析
摘抄自 从去年10月份开始,学了几个月的领域驱动设计(Domain Driven Design,简称DDD).主要是学习领域驱动设计之父Eric Evans的名著:<Domain-driven ...
随机推荐
- python+Eclipse+pydev环境搭建1
编辑器: Eclipse + pydev插件 1. Eclipse是写JAVA的IDE, 这样就可以通用了,学习代价小. 学会了Eclipse, 以后写Python或者JAVA 都可以. 2. Ec ...
- nginx代理yum
适用场景:有多台服务器,但是只有1台服务器可以出公网,此时即可使用如下方式,进行yum代理,解决内网服务器不能yum的尴尬. 一.首先需要把/etc/yum.repos.d下的文件备份到bak,然后留 ...
- docker 私有镜像服务器搭建
1.准备一台服务器A(已安装docker, IP:192.168.39.111) 2.在服务器A上通过运行registry容器进行搭建 docker run -itd -v /my_registry: ...
- python直接赋值、深浅拷贝实例剖析
根据数据类型分为两部分进行剖析: int.str类型 list.tuple.dict类型等 1. int.str类型 [int类型实例] >>> import copy ...
- DEV Express
记录在使用DEV Express中遇到的所有问题及解决方案 问题1:将Dev11升级到Dev14 解决方案:将解决方案中原有Dev引用删除,重新添加必须的Dev14引用,问题解决: 问题2:LC.ex ...
- 关于Hibernate中No row with the given identifier exists问题的原因及解决
今天遇到一个bug,截图如下 有两张表,table1和table2.产生此问题的原因就是table1里做了关联<one-to-one>或者<many-to-one unique=&q ...
- python练习——小程序
1.打印0-10(while/for) count = 0 while count < 11: print(count) count += 1 for i in range(11): print ...
- c#如何判断textbox中输入的数据是datatime型的
()你好,标准的方法是用一个验证控件:RangeValidator,把type设为DateTime,最大值设为'3000-1-1'或者别的,最小值最好设为'1900-1-1'. ()程序里面自己验证: ...
- String类型根据逗号分隔转为list
String ids = pd.getString("IDS");//从pd里取出字符串 List idList = Arrays.asList(ids.split(", ...
- 把disable maven nature后的项目,恢复菜单呈现出来(Convert to Maven Project)
把disable maven nature后的项目,恢复菜单呈现出来(Convert to Maven Project) 有的时候需求把disable maven nature后的项目,再转换为mav ...