51dev.com IT技术开发者社区

51dev.com 技术开发者社区

restful规范

Pythonphp学习阅读(8)2019-10-10 收藏0次评论

restful现在非常流行,所以很有必要提一下

 

web服务交互

浏览器中能看到的每个网站,都是一个web服务。那么我们在提供每个web服务的时候,都需要前后端交互,前后端交互就一定有一些实现方案,我们通常叫web服务交互方案。

 

目前主流的三种web服务交互方案:

  • rest ( representational state transfer)表述性状态转移
  • soap (simple object access protocol) 简单的对象访问协议
  • xml-rpc (xml remote procedure call)基于xml的远程过程调用

 

xml-rpc是通过xml将调用函数封装,并使用http协议作为传送机制。后来在新的功能不断被引入下,这个标准慢慢演变成为今日的soap协定。soap服务则是以本身所定义的操作集,来访问网络上的资源。soap也是基于xml的,但是它不只限于http协议的传输,包括tcp协议,udp协议都可以传输。

 

rest是roy thomas fielding博士于2000年在他的博士论文里提出来的。rest相比soap更加简洁,性能和开发效率也有突出的优势。现在越来越多的web服务开始采用rest风格设计和实现。

 

什么是rest

rest,即representational state transfer,表征性状态转移。这里所说的表征性,其实指的就是资源。通常我们称为资源状态转移

 

什么是资源

 

任何事物,只要有被引用到的必要,它就是一个资源。在浏览器中看到的文本,视频,图片等等都是资源。这些都是实实在在存在的实体。

资源可以是一个实体,也可以是抽象概念。

比如:

  你的基本信息

  你的手机号

  你和女朋友的关系

 

这些都是资源,可以是实体比如个人信息,手机号。也可以是抽象的概念,比如两个人的关系,那么在我们的网络中,我们要引用资源,资源一定要有一个标识,在web中的唯一标识就是uri,而我们经常听到的是url

 

什么是uri,url


uri 统一资源标志符

url 统一资源定位符

 

uri是给我们的资源进行标识的,url是描述我们资源地址的。比如说我们每个人都有名字和身份证,名字可能重名,但是身份证是唯一的,那么身份证号就可以是我们的uri,标识我们每个人,也可以说标识我们每个资源。

可以通过身份证号(uri)找到你

也可以通过下面这种方式找到你(url):

  你的住址协议://地球/中国/xx省/xx市/xx县/xx镇/xx村/xx号街道/xx号/你

 

url可以说是uri的子集,通过定位的方式实现的uri

这是我们资源的定位,有了资源的地址,就可以访问(找到)资源了

 

统一资源接口

顾名思义,就是把与这个接口相关的操作(功能)统一到一个接口上

 

根据常识url去访问到资源,可以对其增删改查,以前我们可能会为了每个单项的功能都新设计一个url,

比如:

  • /baidu.com/user/list/
  • /baidu.com/user/add/
  • /baidu.com/user/edit/(?p<id>d+)/
  • /baidu.com/user/del/(?p<id>d+)/

 

上面的每一个url就是对数据进行增删改查的,而现在就只有一个url——/baidu.com/user/list/ ,根据http请求方式的不同,对资源进行不同的操作,这个就是是统一资源接口,但必须要遵守http的相关协议

 

资源的表述

 

这其实就是资源的展现形式,我们客户端和服务端传输的都是资源的表述,而不是资源本身。例如文本资源可以采用html、xml、json等格式,图片可以使用png或jpg展现出来。那么客户端如何知道服务端提供哪种表述形式呢,可以通过http内容协商,客户端可以通过accept头请求一种特定格式的表述,服务端则通过content-type告诉客户端资源的表述形式。这些资源的表述呈现在页面上,就是我们说的资源状态。

 

状态转移

 

我们在看页面的时候,从当前资源的表述(也可以说状态或者表现层)会跳转到其他的资源状态。服务端通过超媒体告诉客户端当前状态有哪些后续状态可以进入。这些类似"下一页"之类的链接起的就是这种推进状态的作用——指引你如何从当前状态进入下一个可能的状态。

 

总结:

  • 在web中,只要有被引用的必要都叫资源。
  • 每个uri代表一个资源,独一无二的。
  • 客户端通过http的方法,对服务器端资源进行操作;
  • 客户端和服务器之间,传递这种资源的某种表现层;
  • 通过超链接的指引,实现"表现层状态转移"。

 

restful

restful只是一个规范或者约束条件,并不是硬性规定,但建议遵守这项在程序开发界都遵守的规则。

如果一个架构符合rest的约束条件和原则,我们就称它为restful架构。

一种软件的架构风格,设计风格,  为客户端和服务端的交互提供一组设计原则和约束条件。

 

有哪些规范

 

一  面向资源编程

  每个url代表一种资源,url中尽量不要用动词,要用名词,比如:/baidu.com/user/list/

二  根据method不同,进行不同的操作

  get/post/put/delete/patch

三  在url中体现版本

  • https://www.bootcss.com/v1/mycss
  • https://v1.bootcss.com/mycss

四  在url中体现是否是api

  • https://www.bootcss.com/api/mycss
  • https://api.bootcss.com/mycss

五  在url中的过滤条件

  https://www.bootcss.com/v1/mycss?page=2&keyword=test

六  尽量使用https

  https://www.bootcss.com/v1/mycss

七  响应时设置状态码

  • 1**:信息,服务器收到请求,需要请求者继续执行操作
  • 2**:成功,操作被成功接收并处理
  • 3**:重定向,需要进一步的操作以完成请求
  • 4**:客户端错误,请求包含语法错误或无法完成请求
  • 5**:服务器错误,服务器在处理请求的过程中发生了错误

八  返回值

  get请求 返回查到所有或单条数据

  post请求  返回新增的数据

  put请求  返回更新数据

  patch请求  局部更新  返回更新整条数据

  delete请求  返回值为空

九  返回错误信息

  返回值携带错误信息

十   hypermedia api

  如果遇到需要跳转的情况 携带调转接口的url

  ret = {                 code: 1000,                 data:{                     id:1,                     name:'小明',                     content_id:http://www.xxx.com/api/v1/content/8/                 }             }

  

 

以上就是restful规范的全部内容,请多关注【51DEV】IT技术开发者社区。