CherryPy教程

CherryPy 网络服务

网络服务是一组基于网络的组件,有助于在应用程序或系统之间交换数据,其中还包括开放协议和标准。它可以在网络上发布、使用和找到。
Web 服务有多种类型,例如 RWS(RESTfUL Web 服务)、WSDL、SOAP 等等。

REST — 具象状态传输

一种远程访问协议,它将状态从客户端传输到服务器,可用于操作状态而不是调用远程过程。
没有定义任何特定的编码或结构以及返回有用错误消息的方式。 使用 HTTP"动词"来执行状态传输操作。 资源使用 URL 进行唯一标识。 它不是 API,而是 API 传输层。
REST 维护网络上资源的命名法,并提供统一的机制来对这些资源执行操作。每个资源由至少一个标识符标识。如果 REST 基础设施是基于 HTTP 实现的,那么这些标识符被称为 统一资源标识符 (URI)
以下是 URI 集的两个常见子集-
子集 完整表格 示例
URL 统一资源定位器 http://www.gmail.com/
URN 统一资源名称 urn:isbn:0-201-71088-9 urn:uuid:13e8cf26-2a25-11db-8693-000ae4ea7d46
在了解 CherryPy 架构的实现之前,我们先来了解一下 CherryPy 的架构。
CherryPy 包括以下三个组件-
cherrypy.engine-它控制进程启动/拆卸和事件处理。 cherrypy.server-它配置和控制 WSGI 或 HTTP 服务器。 cherrypy.tools-与处理 HTTP 请求正交的实用程序工具箱。

通过 CherryPy 的 REST 接口

RESTful Web 服务在以下帮助下实现了 CherryPy 架构的每个部分-
Authentication Authorization Structure Encapsulation Error Handling

身份验证

身份验证有助于验证我们与之交互的用户。 CherryPy 包含处理每种身份验证方法的工具。
def authenticate():
   if not hasattr(cherrypy.request, 'user') or cherrypy.request.user is None:
      # < do stuff to look up your users >
		
      cherrypy.request.authorized = false # this only authenticates. 
         Authz must be handled separately.
		
      cherrypy.request.unauthorized_reasons = []
      cherrypy.request.authorization_queries = []
		
cherrypy.tools.authenticate = \
   cherrypy.Tool('before_handler', authenticate, priority=10)
上述函数authenticate() 将有助于验证客户端或用户的存在。内置工具有助于系统地完成流程。

授权

授权有助于通过 URI 维护流程的完整性。该过程还有助于根据用户令牌线索对对象进行变形。
def authorize_all():
   cherrypy.request.authorized = 'authorize_all'
	
cherrypy.tools.authorize_all = cherrypy.Tool('before_handler', authorize_all, priority=11)
def is_authorized():
   if not cherrypy.request.authorized:
      raise cherrypy.HTTPError("403 Forbidden",
         ','.join(cherrypy.request.unauthorized_reasons))
			
cherrypy.tools.is_authorized = cherrypy.Tool('before_handler', is_authorized, 
priority = 49)
cherrypy.config.update({
   'tools.is_authorized.on': true,
   'tools.authorize_all.on': true
})
内置的授权工具有助于系统地处理例程,如前面的示例所述。

结构

维护 API 的结构有助于减少映射应用程序 URI 的工作量。始终有必要保持 API 的可发现性和清洁度。 CherryPy 框架的 API 基本结构应具有以下内容-
Accounts and User Autoresponder Contact File Folder List and field Message and Batch

封装

封装有助于创建轻量级、人类可读且可供各种客户端访问的 API。项目列表以及创建、检索、更新和删除需要 API 封装。

错误处理

如果 API 无法按照特定的本能执行,则此流程会管理错误(如果有)。例如,400 表示错误请求,403 表示未经授权的请求。

示例

将以下内容作为数据库、验证或应用程序错误的示例。
import cherrypy
import json
def error_page_default(status, message, traceback, version):
   ret = {
      'status': status,
      'version': version,
      'message': [message],
      'traceback': traceback
   }
	
   return json.dumps(ret)
	
class Root:
   _cp_config = {'error_page.default': error_page_default}
	
@cherrypy.expose
   def index(self):
      raise cherrypy.HTTPError(500, "Internal Sever Error")
cherrypy.quickstart(Root())
上面的代码将产生以下输出-
错误处理
由于内置的​​访问工具,可以通过 CherryPy 轻松管理 API(应用程序编程接口)。

HTTP 方法

对资源进行操作的 HTTP 方法列表如下-
S.No HTTP 方法和操作
1.
HEAD
检索资源元数据。
2.
GET
检索资源元数据和内容。
3.
POST
请求服务器使用请求正文中包含的数据创建新资源。
4.
PUT
请求服务器用请求正文中包含的资源替换现有资源。
5.
DELETE
请求服务器删除由该 URI 标识的资源。
6.
OPTIONS
请求服务器返回有关全局或特定资源的功能的详细信息。

Atom 发布协议 (APP)

APP 起源于 Atom 社区,作为 HTTP 之上的应用级协议,允许发布和编辑网络资源。 APP服务器和客户端之间的消息单元基于Atom XML-document格式。
Atom 发布协议使用 HTTP 及其机制和 Atom XML 文档格式作为消息单元定义了 APP 服务和用户代理之间的一组操作。
APP 首先定义了一个服务文档,该文档为用户代理提供了 APP 服务所服务的不同集合的 URI。

示例

让我们举一个例子来演示APP是如何工作的-
<?xml version = "1.0" encoding = "UTF-8"?>
<service xmlns = "http://purl.org/atom/app#" xmlns:atom = "http://www.w3.org/2005/Atom">
   
   <workspace>
      <collection href = "http://host/service/atompub/album/">
         <atom:title> Albums</atom:title>
         <categories fixed = "yes">
            <atom:category term = "friends" />
         </categories>
      </collection>
      
      <collection href = "http://host/service/atompub/film/">
         <atom:title>Films</atom:title>
         <accept>image/png,image/jpeg</accept>
      </collection>
   </workspace>
	
</service>
APP 指定如何使用 HTTP 方法对集合的成员或集合本身执行基本的 CRUD 操作,如下表所述-
操作 HTTP 方法 状态码 内容
Retrieve GET 200 代表资源的 Atom 条目
Create POST 201 通过 Location 和 Content-Location 标头的新创建资源的 URI
Update PUT 200 代表资源的 Atom 条目
Delete DELETE 200
昵称: 邮箱:
Copyright © 2022 立地货 All Rights Reserved.
备案号:京ICP备14037608号-4