REST api架构

简介:
RESTful架构,就是目前最流行的一种互联网软件架构 。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。

REST优势

REST改善了用户接口跨多个平台的可移植性,并且通过简化服务器组件,改善了系统的可伸缩性。最为关键的是通过分离用户接口和数据存储这两个关注点,使得不同用户终端享受相同数据成为了可能。

1. 无状态性

无状态性是在客户-服务器约束的基础上添加的又一层规范。他要求通信必须在本质上是无状态的,即从客户到服务器的每个request都必须包含理解 该request所必须的所有信息。这个规范改善了系统的可见性(无状态性使得客户端和服务器端不必保存对方的详细信息,服务器只需要处理当前 request,而不必了解所有的request历史),可靠性(无状态性减少了服务器从局部错误中恢复的任务量),可伸缩性(无状态性使得服务器端可以 很容易的释放资源,因为服务器端不必在多个request中保存状态)。同时,这种规范的缺点也是显而易见得,由于不能将状态数据保存在服务器上的共享上 下文中,因此增加了在一系列request中发送重复数据的开销,严重的降低了效率。

2. 缓存

为了改善无状态性带来的网络的低效性,我们填加了缓存约束。缓存约束允许隐式或显式地标记一个response中的数据,这样就赋予了客户端缓存 response数据的功能,这样就可以为以后的request共用缓存的数据,部分或全部的消除一部分交互,增加了网络的效率。但是用于客户端缓存了信 息,也就同时增加了客户端与服务器数据不一致的可能,从而降低了可靠性。

B/S架构的优点是其部署非常方便,但在用户体验方面却不是很理想。为了改善这种情况,我们引入了REST. REST在原有的架构上增加了三个新规范:统一接口,分层系统和按需代码。

3. 统一接口

REST架构风格的核心特征就是强调组件之间有一个统一的接口,这表现在REST世界里,网络上所有的事物都被抽象为资源,而REST就是通过通用 的链接器接口对资源进行操作。这样设计的好处是保证系统提供的服务都是解耦的,极大的简化了系统,从而改善了系统的交互性和可重用性。并且REST针对 Web的常见情况做了优化,使得REST接口被设计为可以高效的转移大粒度的超媒体数据,这也就导致了REST接口对其它的架构并不是最优的。

4. 分层系统

分层系统规则的加入提高了各种层次之间的独立性,为整个系统的复杂性设置了边界,通过封装遗留的服务,使新的服务器免受遗留客户端的影响,这也就提高了系统的可伸缩性。

5. 按需代码

REST允许对客户端功能进行扩展。比如,通过下载并执行applet或脚本形式的代码,来扩展客户端功能。但这在改善系统可扩展性的同时,也降低了可见性。所以它只是REST的一个可选的约束。

 

REST规范接口

每个资源都有对应的URI,不同的HTTP Method对应的对资源不同的操作,GET(读取资源信息)、POST(添加资源)、PUT(更新资源信息)、DELETE(删除资源)。几乎所有的计算机语言都可以通过HTTP协议同REST服务器通信。

Java代码   收藏代码
  1. GET /tickets # 获取ticket列表  
  2. GET /tickets/12 # 查看某个具体的ticket  
  3. POST /tickets # 新建一个ticket  
  4. PUT /tickets/12 # 更新ticket 12.  
  5. DELETE /tickets/12 #删除ticekt 12  

如果关系依托于另外一个资源,Restful原则提供了很好的指导原则。让我们来看一个例子。SupportFu的一个ticket包含许多消息(message)。这些消息逻辑上与/tickets接入点的映射关系如下:

  • GET /tickets/12/messages - 获取ticket #12下的消息列表
  • GET /tickets/12/messages/5 - 获取ticket #12下的编号为5的消息
  • POST /tickets/12/messages - 为ticket #12创建一个新消息
  • PUT /tickets/12/messages/5 - 更新ticket #12下的编号为5的消息
  • PATCH /tickets/12/messages/5 - 部分更新ticket #12下的编号为5的消息
  • DELETE /tickets/12/messages/5 - 删除ticket #12下的编号为5的消息

结果过滤,排序和搜索

GET /tickets?sort=-priority - 获取票据列表,按优先级字段降序排序

 

场景:

  • A:http://www.nowamagic.net/articles
  • B:http://www.nowamagic.net/articles/{id}

A网址:GET方法:显示全部用户信息;同时有个POST方法,用来添加用户;

B网址:GET方法:显示当前用户信息;PUT方法:更新用户信息;DELETE方法:删除该用户信息。

 注意RESTClient form的enctype属性x-www-form-urlencoded,form-data 是文件上传

最常见的一种设计错误,就是URI包含动词 因为"资源"表示一种实体,所以应该是名词,URI不应该有动词,动词应该放在HTTP协议中。举例来说,某个URI是/posts/show/1,其中show是动词,这个URI就设计错了,正确的写法应该是/posts/1,然后用GET方法表示show。

如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源。比如网上汇款,从账户1向账户2汇款500元,错误的URI是:

Java代码   收藏代码
  1. POST/accounts/1/transfer/500/to/2  

 正确的写法是把动词transfer改成名词transaction,资源不能是动词,但是可以是一种服务:

Java代码   收藏代码
  1. POST/transaction  
  2.   
  3. HTTP/1.1  
  4. Host: 127.0.0.1  
  5. from=1&to=2&amount=500.00  

另一个设计误区,就是在URI中加入版本号:

Java代码   收藏代码
  1. http://www.example.com/app/1.0/foo  
  2. http://www.example.com/app/1.1/foo  

因为不同的版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分

Java代码   收藏代码
  1. Accept: vnd.example-com.foo+json; version=1.0  
  2. Accept: vnd.example-com.foo+json; version=1.1  

二、处理返回值。 返回值要么是JSON格式,要么是XML格式。

PHP如何获取rest的HTTP的请求PUT或DELETE的数据

Java代码   收藏代码
  1. $method = $_SERVER['REQUEST_METHOD']; //请求  
  2. $rawbody = file_get_contents("php://input");  
  3. $form = json_decode($rawbody, true); //数据  

前端 MVC 框架支持

在 AngularJS 中原生提供了 RESTful 的操作接口。也可以用jQuery的Ajax,浏览器支持不好

Java代码   收藏代码
  1. //注意:Jquery其它HTTP请求方法,如PUT和DELETE 也可以使用,但仅部分浏览器支持。  
  2. //getOne or delete  
  3. $.ajax({  
  4.     url:'/api/work/1',  
  5.     type:"GET"//DELETE  
  6.     success:function(data) {  
  7.       console.log(data);  
  8.     },  
  9.     error:function (xhr, ajaxOptions, thrownError){  
  10.       console.log(xhr.responseText);  
  11.     }   
  12.   });  
  13.   
  14. var postData = {  
  15.     "title""title31",  
  16.     "author_id""31",  
  17.     "content""content31",  
  18.     "create_time""2013-08-20 09:23:14"  
  19. };  
  20. //create or update  
  21. $.ajax({  
  22.     url:'/api/work',  
  23.     data:JSON.stringify(postData)  
  24.     type:"POST"//PUT  
  25.     success:function(data) {  
  26.         console.log(data);  
  27.     },  
  28.     error:function (xhr, ajaxOptions, thrownError){  
  29.         console.log(xhr.responseText);  
  30.     }   
  31. });  

sfsd

相关文章
|
2月前
|
JavaScript 前端开发 API
从架构到API,你真的掌握了Electron的全貌吗?
本文首发于微信公众号“前端徐徐”。作者徐徐从架构层面、协作方式、底层支持、源码层面及API设计等方面剖析了Electron的原理。通过分析Electron的核心组件(Chromium和Node.js)、进程隔离、上下文桥接及IPC机制等内容,揭示了Electron在设计上的精妙之处及其对开发高效、稳定桌面应用的重要性。了解这些原理有助于开发者更好地设计和解决问题。
152 2
从架构到API,你真的掌握了Electron的全貌吗?
|
20天前
|
缓存 负载均衡 JavaScript
探索微服务架构下的API网关模式
【10月更文挑战第37天】在微服务架构的海洋中,API网关犹如一座灯塔,指引着服务的航向。它不仅是客户端请求的集散地,更是后端微服务的守门人。本文将深入探讨API网关的设计哲学、核心功能以及它在微服务生态中扮演的角色,同时通过实际代码示例,揭示如何实现一个高效、可靠的API网关。
|
2月前
|
缓存 监控 API
探索微服务架构中的API网关模式
【10月更文挑战第5天】随着微服务架构的兴起,企业纷纷采用这一模式构建复杂应用。在这种架构下,应用被拆分成若干小型、独立的服务,每个服务围绕特定业务功能构建并通过HTTP协议协作。随着服务数量增加,统一管理这些服务间的交互变得至关重要。API网关作为微服务架构的关键组件,承担起路由请求、聚合数据、处理认证与授权等功能。本文通过一个在线零售平台的具体案例,探讨API网关的优势及其实现细节,展示其在简化客户端集成、提升安全性和性能方面的关键作用。
75 2
|
2月前
|
存储 缓存 监控
探索微服务架构中的API网关模式
【10月更文挑战第1天】探索微服务架构中的API网关模式
95 2
|
2月前
|
设计模式 API 开发者
探索现代后端开发:微服务架构与API设计
【10月更文挑战第6天】探索现代后端开发:微服务架构与API设计
|
26天前
|
监控 安全 应用服务中间件
微服务架构下的API网关设计策略与实践####
本文深入探讨了在微服务架构下,API网关作为系统统一入口点的设计策略、实现细节及其在实际应用中的最佳实践。不同于传统的摘要概述,本部分将直接以一段精简的代码示例作为引子,展示一个基于NGINX的简单API网关配置片段,随后引出文章的核心内容,旨在通过具体实例激发读者兴趣,快速理解API网关在微服务架构中的关键作用及实现方式。 ```nginx server { listen 80; server_name api.example.com; location / { proxy_pass http://backend_service:5000;
|
28天前
|
缓存 监控 API
探索微服务架构中的API网关模式
随着微服务架构的兴起,API网关成为管理和服务间交互的关键组件。本文通过在线零售公司的案例,探讨了API网关在路由管理、认证授权、限流缓存、日志监控和协议转换等方面的优势,并详细介绍了使用Kong实现API网关的具体步骤。
46 3
|
28天前
|
存储 缓存 监控
探索微服务架构中的API网关模式
探索微服务架构中的API网关模式
48 2
|
1月前
|
缓存 API 网络架构
掌握现代API开发:GraphQL vs REST
【10月更文挑战第24天】本文深入探讨了现代API开发中两种主流技术——GraphQL和REST的设计理念、技术特点及实际开发中的对比分析。GraphQL通过声明式数据请求和强类型系统提供更高的灵活性和性能,而REST则以其无状态特性和成熟的生态系统见长。文章还讨论了两者在客户端-服务器交互、安全性和工具支持方面的优劣,帮助开发者根据项目需求做出明智选择。
|
2月前
|
消息中间件 NoSQL Kafka
大数据-52 Kafka 基础概念和基本架构 核心API介绍 应用场景等
大数据-52 Kafka 基础概念和基本架构 核心API介绍 应用场景等
65 5