Openstack API 类型 & REST 风格

目录

• 目录
• Openstack 提供了三种操作方式
  • Web界面
  • CIL 指令行
  • RESTful API
• REST 风格
  • RESTFul风格的API设计
• 基于HTTP协议的RESTful API
• OpenStack中的RESTful API开发框架

Openstack 提供了三种操作方式

Web界面

也就是通过Dashboard（儀表板）来使用Openstack雲計算平台上的功能。通过Web界面使用 OpenStack Services 这种方式是通过 OpenStack Horizon Project 提供的。Horizon Project 是一个Django Web Application。Horizon Project 会通过API来和各个 OpenStack Services 进行交互，然后在 Web 界面上顯示這些 Services 的状态和交互結果。

CIL 指令行

通过以往的 keystone、nova、neutron 等指令，或者通过最新的 OpenStack 指令来操作各个 Services 的功能。社区目前希望使用統一的 OpenStack 指令來代替以往每个 Project 都有各自的 Commands 的方式，这些 Commands 是由命名为 client(EG. keystoneclient、novaclient) 的項目所實現的。這些 client 項目除了爲用户提供命令行操作界面方式之外還提供了 Python 的 SDK (其实是在SDK的基础上实现了命令行)。这些 client 项目提供的 SDK 本質是封装了這些 Openstack services 的 API 的调用。現在 Openstack 社區希望僅使用 openstackclient 作爲统一的命令行工具，然后使用各个 Services 的 client 项目所提供的 SDK 来完成相应的操作。

RESTful API

通过各个 OpenStack Project 提供的 API 来使用各 Services 的功能。API 这种方式是支撐上述兩種方式的基础，由各个 Services 自身來实现使用 API 操作 OpenStack 的方式。这些 API 具有统一的形式，均采用了基於 HTTP 协议的 Restful 风格来实现。Openstack API 服务进程在接收了客户端的HTTP Request之后，一个所谓的 路由 模块就会将URL转换成为相应的资源，并路由到合适的操作函数上去。以此来实现了从API到具体操作的映射。

REST 风格

REST(Representational State Transfer)表述性状态转换，是一种软件架构的设计风格，而不是一种标准，为软件设计提供了一组原则和约束条件，但这是原则和约束的条件也同样不具有标准性。所以也可以将REST理解为是一组没有严格标准的架构约束条件和设计原则。REST的软件设计倾向于简单轻量的方法设计和实现，以及**REST具有通过HTTP直接传输数据的特性。**REST风格的软件架构必须满足下面两点规范：

• URI 标识资源：首先从Restful的角度来看，互联网上的任何东西(文本/图片/视频/歌曲/Services)都是一个资源。每个资源都使用了一个特定的URI来唯一标示，访问这一个URI就是访问这一个资源，而且这个资源具有至少一种状态。

• 无状态原则： 再一个就是，Client 和 Server 之间互相传递的只是资源的表述，即：调用资源的URI并获取资源的不同表现形式。并且 Client 和 Server 之间的交互是由 HTTP 无状态协议来支撑的，所以资源的所有状态都只会保存在 Server 中。当 Client 应用 HTTP 协议中的 GET/POST/PUT/DELETE 操作资源时，会使得 Server 中的资源的状态发生转换，这就是所谓的“表述性状态转换”。

RESTFul风格的API设计

你的URI中应该都是名词，表示一个事物，而非动词。EG. /resources/142 是好的URI，它看起来像是一个事物 而 /resources/142/get 则不是好的URI，因为它看起来更像是一个动作，只有事物才符合资源的定义。

• 面向资源的体系结构
• URI使用名词，不使用动词
• 资源地址即URI
• 无状态性
• 灵活使用单数和复数
• 传输资源的表现形式(Web Server 接收和返回的互联网媒体类型，JSON/XML)
• 对资源的操作与HTTP内置方法映射

基于HTTP协议的RESTful API

由于这种软件设计风格非常适合采用HTTP协议来实现，因此HTTP协议是目前实现RESTful API的主要方案。

OpenStack 就是基于 HTTP 协议和 JSON 来实现自己的 RESTful API（之前OpenStack还有采用XML来表示数据的，现在都已经转到JSON了）。当一个 Service 要对外提供 API 时，它就会启动一个 HTTP Web Server，用来对外提供 RESTful API。

OpenStack 的 API 都是有详细的文档记录的，可以查看所有的API文档。

OpenStack 的 API 服务都是使用 WSGI 的方式来部署的。部署WSGI，一般会使用 Web Server + Application Server + Application(框架) 的部署方式。OpenStack 官方推荐的是使用 Apache + mod_wsgi ，当然你也可以选 nginx + uWSGI 。还有些项目会提供使用 eventlet 的单进程部署方案(EG. Keystone项目的keystone-all命令)。

OpenStack中的RESTful API开发框架

OpenStack 早期的核心项目(EG. Keystone/Nova/Glance/Neutron)使用了由几个模块组合出来的一个框架： Paste + PasteDeploy + Routes + WebOb 。这些模块分别负责了应用的 WSGI 化、URL 路由和请求处理等功能。但是这种框架存在着较为复杂的弊端，所以现在 Openstack 社区的新项目已经开始使用新的 Web 框架 Pecan。

Pecan 是一个基于对象路由的框架，即灵活又简单。Pecan 主要实现了 URL 路由功能，支持 RESTful API 。Pecan 没有实现模板、session 管理、 ORM 等功能，但是这些功能可以通过其他的模块来实现。对于 OpenStack 来说，Pecan 是一个很好的选择，因为 OpenStack 项目中统一使用 sqlalchemy 来实现ORM，API的实现也不需要模板功能，安全控制则基于 Keystone 体系。使用 Pecan 来开发 REST 服务，代码量很少，代码结构也清晰。