学习OpenStack就绕不开REST API,因为组件之间的通信就是通过REST API来实现的,所以不管是日常运维还是故障排错,都需要对REST API有一定的了解。今天我们就来一起看一下。
什么是REST?
这是最基本的问题。REST全称Representational State Transfer,翻译过来叫表现层状态转换。是Roy Thomas Fielding博士于2000年在他的博士论文中提出来的一种万维网软件架构风格,目的是便于不同软件/程序在网络中互相传递信息。注意,REST只是一种软件设计风格,而不是一种标准,也不是一种实现。
什么是WSGI?
上面说了REST只是一种设计风格,而不是具体实现,WSGI就是一种具体实现,也是我们OpenStack中常见的一种REST的实现。
WSGI全称Web Server Gateway Interface。是Python语言中定义的Web 服务器和Web 应用程序之间的接口标准。还记得我们在"认识OpenStack"中提到的一件事情吗?就是OpenStack在成立之初约定的一个事情,代码使用Python来写。所以我们在OpenStack中见到的REST API基本都是WSGI的实现方式。
什么是API?
API全称是Application Programming Interface, 应用程序编程接口,是一些预先定义的函数。目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。--- 这是百度百科的定义。
其实说简单点,API就是一个接口,你往里面按照格式扔进去一些参数,里面定义好的函数就会基于你给出的参数给你回复一个结果。而你并不需要知道这些函数的代码以及它是怎么工作的。
打个比方,你是老师,我是学生,我向你提问A这道题怎么解。我的问题提出来以后,我作为学生,不管你是自己分析,还是去百度,还是去请教别的老师。只知道最终你会告诉我一个答案。那么作为老师的你,就是一个人肉API。作为学生,我不清楚你是怎么得到的答案,我只知道向你提问就好了,最终会得到一个答案。这就是API。
什么是REST API?
前面介绍了REST,WSGI和API的概念,那么现在你应该可以猜出来了,REST API就是符合REST风格的API,具体到OpenStack里,就是WSGI API。
REST具体是什么风格?
前面说了REST是一种软件架构风格,他的风格主要就是下面几条:
资源是由URI来指定。
对资源的操作包括获取、创建、修改和删除,这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。
通过操作资源的表现形式来操作资源。
资源的表现形式则是XML或者HTML,当然也可以是任何其他的格式,例如JSON。
简单来说,REST就是对资源的操作都可以通过URI来完成,REST是基于资源的。这里主要针对URI这个概念做一点详细的阐述。
什么是URI?
说URI大家可能不熟,但是说URL可能大家没有不熟悉的。那么URI和URL到底是什么关系?什么?还有URN,那又是什么鬼?让我们一起来看一下。
URI:Uniform Resource Identifier,统一资源标识符
URL:Uniform Resource Location,统一资源定位符
URN:Uniform Resource Name,统一资源名称
我刚开始看到这几个词儿脑袋也有点大,搞不清他们有什么区别,等我研究了一下以后发现他们的逻辑关系是这样的,先看图:
从图中能看出来,URL和URN他们都属于URI,是URI的子集。具体区别如下:
URI侧重标识:是一个大的概念,它的对象是互联网上的资源,可能是一张图片,一段文字或是一段视频。只要你你能按照某种逻辑规律将他们唯一地标识,那么任意一个资源的标识符就是一个URI,具体你采用什么逻辑规律去标识,它不管。
URL侧重定位:它首先是一种URI,所以它能唯一的标识互联网上的某个资源,而且它要求通过这个URL,电脑要能定位出来这个资源的位置,从而可以访问它。具体怎么定位,不同的协议又有不同的定位方式。比如http协议的URL是这样:http://www.wikipedia.org/;FTP协议的URL是这样的ftp://ftp.is.co.za/rfc/rfc1808.txt。
URN侧重名字:比如国际标准书号ISBN就是一种URN,它按照一个特定逻辑给每一本书规定了一个独一无二的编号,比如ISBN 0-486-27557-4。通过这个编号,你可以知道这是一本什么样的书,但是与URL不同的是你不知道它在哪里。
REST API是如何工作的?
REST的工作是不依赖于协议的,但是几乎全部的REST都是基于HTTP协议的。所以我们就看一下基于http的REST API是如何工作的。
HTTP的交互的过程是客户端发出一个请求,然后服务器返回一个请求。交互的过程中,除了传递的数据之外,还需要一些额外的信息来帮助客户端和服务端进行协商,确保通信的畅通,这部分信息会包含在header中。
一个REST的HTTP请求如图:
各字段解释如下:
VERB:HTTP的方法,例如GET POST DELETE等
URI:指定资源的位置
HTTP Version:HTTP的版本
Request Header:详细内容见附录。
Request Body:包含实际传递的消息。
服务端收到请求后会给出相应,响应的格式如下:
各字段解释如下:
HTTP Version:HTTP的版本
Response Code :表示请求的状态,详细内容见附录。
Response Header:详细内容见附录。
Response Body :包含实际数据。
有请求,有响应,REST API就可以正常工作了。
到此为止,REST API的基本概念和理论就说完了。希望对大家的理解有所帮助。附录是我收集的request和response header的内容和http的四种操作对应的response code含义,供大家参考。
附录:
Request Header:
Header | 解释 | 示例 |
---|---|---|
Accept | 指定客户端能够接收的内容类型 | Accept: text/plain, text/html |
Accept-Charset | 浏览器可以接受的字符编码集。 | Accept-Charset: iso-8859-5 |
Accept-Encoding | 指定浏览器可以支持的web服务器返回内容压缩编码类型。 | Accept-Encoding: compress, gzip |
Accept-Language | 浏览器可接受的语言 | Accept-Language: en,zh |
Accept-Ranges | 可以请求网页实体的一个或者多个子范围字段 | Accept-Ranges: bytes |
Authorization | HTTP授权的授权证书 | Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
Cache-Control | 指定请求和响应遵循的缓存机制 | Cache-Control: no-cache |
Connection | 表示是否需要持久连接。(HTTP 1.1默认进行持久连接) | Connection: close |
Cookie | HTTP请求发送时,会把保存在该请求域名下的所有cookie值一起发送给web服务器。 | Cookie: $Version=1; Skin=new; |
Content-Length | 请求的内容长度 | Content-Length: 348 |
Content-Type | 请求的与实体对应的MIME信息 | Content-Type: application/x-www-form-urlencoded |
Date | 请求发送的日期和时间 | Date: Tue, 15 Nov 2010 08:12:31 GMT |
Expect | 请求的特定的服务器行为 | Expect: 100-continue |
From | 发出请求的用户的Email | From: user@email.com |
Host | 指定请求的服务器的域名和端口号 | Host: www.zcmhi.com |
If-Match | 只有请求内容与实体相匹配才有效 | If-Match: “737060cd8c284d8af7ad3082f209582d” |
If-Modified-Since | 如果请求的部分在指定时间之后被修改则请求成功,未被修改则返回304代码 | If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT |
If-None-Match | 如果内容未改变返回304代码,参数为服务器先前发送的Etag,与服务器回应的Etag比较判断是否改变 | If-None-Match: “737060cd8c284d8af7ad3082f209582d” |
If-Range | 如果实体未改变,服务器发送客户端丢失的部分,否则发送整个实体。参数也为Etag | If-Range: “737060cd8c284d8af7ad3082f209582d” |
If-Unmodified-Since | 只在实体在指定时间之后未被修改才请求成功 | If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT |
Max-Forwards | 限制信息通过代理和网关传送的时间 | Max-Forwards: 10 |
Pragma | 用来包含实现特定的指令 | Pragma: no-cache |
Proxy-Authorization | 连接到代理的授权证书 | Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
Range | 只请求实体的一部分,指定范围 | Range: bytes=500-999 |
Referer | 先前网页的地址,当前请求网页紧随其后,即来路 | Referer: http://www.zcmhi.com/archives/71.html |
TE | 客户端愿意接受的传输编码,并通知服务器接受接受尾加头信息 | TE: trailers,deflate;q=0.5 |
Upgrade | 向服务器指定某种传输协议以便服务器进行转换(如果支持) | Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11 |
User-Agent | User-Agent的内容包含发出请求的用户信息 | User-Agent: Mozilla/5.0 (Linux; X11) |
Via | 通知中间网关或代理服务器地址,通信协议 | Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1) |
Warning | 关于消息实体的警告信息 | Warn: 199 Miscellaneous warning |
Response header:
Header | 解释 | 示例 |
---|---|---|
Accept-Ranges | 表明服务器是否支持指定范围请求及哪种类型的分段请求 | Accept-Ranges: bytes |
Age | 从原始服务器到代理缓存形成的估算时间(以秒计,非负) | Age: 12 |
Allow | 对某网络资源的有效的请求行为,不允许则返回405 | Allow: GET, HEAD |
Cache-Control | 告诉所有的缓存机制是否可以缓存及哪种类型 | Cache-Control: no-cache |
Content-Encoding | web服务器支持的返回内容压缩编码类型。 | Content-Encoding: gzip |
Content-Language | 响应体的语言 | Content-Language: en,zh |
Content-Length | 响应体的长度 | Content-Length: 348 |
Content-Location | 请求资源可替代的备用的另一地址 | Content-Location: /index.htm |
Content-MD5 | 返回资源的MD5校验值 | Content-MD5: Q2hlY2sgSW50ZWdyaXR5IQ== |
Content-Range | 在整个返回体中本部分的字节位置 | Content-Range: bytes 21010-47021/47022 |
Content-Type | 返回内容的MIME类型 | Content-Type: text/html; charset=utf-8 |
Date | 原始服务器消息发出的时间 | Date: Tue, 15 Nov 2010 08:12:31 GMT |
ETag | 请求变量的实体标签的当前值 | ETag: “737060cd8c284d8af7ad3082f209582d” |
Expires | 响应过期的日期和时间 | Expires: Thu, 01 Dec 2010 16:00:00 GMT |
Last-Modified | 请求资源的最后修改时间 | Last-Modified: Tue, 15 Nov 2010 12:45:26 GMT |
Location | 用来重定向接收方到非请求URL的位置来完成请求或标识新的资源 | Location: http://www.zcmhi.com/archives/94.html |
Pragma | 包括实现特定的指令,它可应用到响应链上的任何接收方 | Pragma: no-cache |
Proxy-Authenticate | 它指出认证方案和可应用到代理的该URL上的参数 | Proxy-Authenticate: Basic |
refresh | 应用于重定向或一个新的资源被创造,在5秒之后重定向(由网景提出,被大部分浏览器支持) | Refresh: 5; url= http://www.zcmhi.com/archives/94.html |
Retry-After | 如果实体暂时不可取,通知客户端在指定时间之后再次尝试 | Retry-After: 120 |
Server | web服务器软件名称 | Server: Apache/1.3.27 (Unix) (Red-Hat/Linux) |
Set-Cookie | 设置Http Cookie | Set-Cookie: UserID=JohnDoe; Max-Age=3600; Version=1 |
Trailer | 指出头域在分块传输编码的尾部存在 | Trailer: Max-Forwards |
Transfer-Encoding | 文件传输编码 | Transfer-Encoding:chunked |
Vary | 告诉下游代理是使用缓存响应还是从原始服务器请求 | Vary: * |
Via | 告知代理客户端响应是通过哪里发送的 | Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1) |
Warning | 警告实体可能存在的问题 | Warning: 199 Miscellaneous warning |
WWW-Authenticate | 表明客户端请求实体应该使用的授权方案 | WWW-Authenticate: Basic |
GET
安全且幂等
200(OK) - 表示已在响应中发出
204(无内容) - 资源有空表示
301(Moved Permanently) - 资源的URI已被更新
303(See Other) - 其他(如,负载均衡)
304(not modified)- 资源未更改(缓存)
400 (bad request)- 指代坏请求(如,参数错误)
404 (not found)- 资源不存在
406 (not acceptable)- 服务端不支持所需表示
500 (internal server error)- 通用错误响应
503 (Service Unavailable)- 服务端当前无法处理请求
POST
不安全且不幂等
200(OK)- 如果现有资源已被更改
201(created)- 如果新资源被创建
202(accepted)- 已接受处理请求但尚未完成(异步处理)
301(Moved Permanently)- 资源的URI被更新
303(See Other)- 其他(如,负载均衡)
400(bad request)- 指代坏请求
404 (not found)- 资源不存在
406 (not acceptable)- 服务端不支持所需表示
409 (conflict)- 通用冲突
412 (Precondition Failed)- 前置条件失败(如执行条件更新时的冲突)
415 (unsupported media type)- 接受到的表示不受支持
500 (internal server error)- 通用错误响应
503 (Service Unavailable)- 服务当前无法处理请求
PUT
不安全但幂等
200 (OK)- 如果已存在资源被更改
201 (created)- 如果新资源被创建
301(Moved Permanently)- 资源的URI已更改
303 (See Other)- 其他(如,负载均衡)
400 (bad request)- 指代坏请求
404 (not found)- 资源不存在
406 (not acceptable)- 服务端不支持所需表示
409 (conflict)- 通用冲突
412 (Precondition Failed)- 前置条件失败(如执行条件更新时的冲突)
415 (unsupported media type)- 接受到的表示不受支持
500 (internal server error)- 通用错误响应
503 (Service Unavailable)- 服务当前无法处理请求
DELETE
不安全但幂等
200 (OK)- 资源已被删除
301 (Moved Permanently)- 资源的URI已更改
303 (See Other)- 其他,如负载均衡
400 (bad request)- 指代坏请求
404 (not found)- 资源不存在
409 (conflict)- 通用冲突
500 (internal server error)- 通用错误响应
503 (Service Unavailable)- 服务端当前无法处理请求