如何使用Pyramid和Cornice编写Python Web API

开发 后端
使用 Pyramid 和 Cornice 构建和描述可扩展的 RESTful Web 服务。

[[313078]]

使用 Pyramid 和 Cornice 构建和描述可扩展的 RESTful Web 服务。

Python 是一种高级的、面向对象的编程语言,它以其简单的语法而闻名。它一直是构建 RESTful API 的顶级编程语言之一。

Pyramid 是一个 Python Web 框架,旨在随着应用的扩展而扩展:这可以让简单的应用很简单,也可以增长为大型、复杂的应用。此外,Pyramid 为 PyPI (Python 软件包索引)提供了强大的支持。Cornice 为使用 Pyramid 构建和描述 RESTful Web 服务提供了助力。

本文将使用 Web 服务的例子来获取名人名言,来展示如何使用这些工具。

建立 Pyramid 应用

首先为你的应用创建一个虚拟环境,并创建一个文件来保存代码:

  1. $ mkdir tutorial
  2. $ cd tutorial
  3. $ touch main.py
  4. $ python3 -m venv env
  5. $ source env/bin/activate
  6. (env) $ pip3 install cornice twisted

导入 Cornice 和 Pyramid 模块

使用以下命令导入这些模块:

  1. from pyramid.config import Configurator
  2. from cornice import Service

定义服务

将引用服务定义为 Service 对象:

  1. QUOTES = Service(name='quotes',
  2.                  path='/',
  3.                  description='Get quotes')

编写引用逻辑

到目前为止,这仅支持获取名言。用 QUOTES.get 装饰函数。这是将逻辑绑定到 REST 服务的方法:

  1. @QUOTES.get()
  2. def get_quote(request):
  3.     return {
  4.         'William Shakespeare': {
  5.             'quote': ['Love all, trust a few, do wrong to none',
  6.             'Some are born great, some achieve greatness, and some have greatness thrust upon them.']
  7.     },
  8.     'Linus': {
  9.         'quote': ['Talk is cheap. Show me the code.']
  10.         }
  11.     }

请注意,与其他框架不同,装饰器不会更改 get_quote 函数。如果导入此模块,你仍然可以定期调用该函数并检查结果。

在为 Pyramid RESTful 服务编写单元测试时,这很有用。

定义应用对象

最后,使用 scan 查找所有修饰的函数并将其添加到配置中:

  1. with Configurator() as config:
  2.     config.include("cornice")
  3.     config.scan()
  4.     application = config.make_wsgi_app()

默认扫描当前模块。如果要扫描软件包中的所有模块,你也可以提供软件包的名称。

运行服务

我使用 Twisted 的 WSGI 服务器运行该应用,但是如果需要,你可以使用任何其他 WSGI 服务器,例如 Gunicorn 或 uWSGI。

  1. (env)$ python -m twisted web --wsgi=main.application

默认情况下,Twisted 的 WSGI 服务器运行在端口 8080 上。你可以使用 HTTPie 测试该服务:

  1. (env) $ pip install httpie
  2. ...
  3. (env) $ http GET <http://localhost:8080/>
  4. HTTP/1.1 200 OK
  5. Content-Length: 220
  6. Content-Type: application/json
  7. Date: Mon, 02 Dec 2019 16:49:27 GMT
  8. Server: TwistedWeb/19.10.0
  9. X-Content-Type-Options: nosniff
  10.  
  11. {
  12.     "Linus": {
  13.         "quote": [
  14.             "Talk is cheap. Show me the code."
  15.         ]
  16.     },
  17.     "William Shakespeare": {
  18.         "quote": [
  19.             "Love all,trust a few,do wrong to none",
  20.             "Some are born great, some achieve greatness, and some greatness thrust upon them."
  21.         ]
  22.     }
  23. }

为什么要使用 Pyramid?

Pyramid 并不是最受欢迎的框架,但它已在 PyPI 等一些引人注目的项目中使用。我喜欢 Pyramid,因为它是认真对待单元测试的框架之一:因为装饰器不会修改函数并且没有线程局部变量,所以可以直接从单元测试中调用函数。例如,需要访问数据库的函数将从通过 request.config 传递的 request.config 对象中获取它。这允许单元测试人员将模拟(或真实)数据库对象放入请求中,而不用仔细设置全局变量、线程局部变量或其他特定于框架的东西。

如果你正在寻找一个经过测试的库来构建你接下来的 API,请尝试使用 Pyramid。你不会失望的。 

责任编辑:庞桂玉 来源: Linux中国
相关推荐

2019-12-23 10:00:52

PythonFlaskPython Web

2020-01-11 17:00:07

DjangoPythonWeb API

2017-09-11 10:55:22

PythonWeb框架

2012-03-08 09:44:41

编程

2024-02-18 08:00:00

PythonAI多模态模型API

2020-09-08 11:30:39

Edge DevTooWebAPI

2023-10-30 10:54:01

2011-09-16 14:21:47

Web API

2023-06-26 10:51:56

开源API

2023-11-23 08:00:00

OpenAILangChain

2024-03-26 12:28:59

.NET 8开发

2021-04-26 05:33:54

Python异步编程

2016-09-14 21:17:47

PythonAsyncio游戏

2016-09-22 21:12:14

2016-09-19 21:24:08

PythonAsyncio游戏

2009-11-23 19:50:33

ibmdwWebService

2021-11-07 14:29:13

ChromeAPI 蓝牙

2012-06-20 14:34:03

jQuery

2019-12-30 09:00:00

Web 开发代码

2022-03-15 12:43:44

Web APIAPI
点赞
收藏

51CTO技术栈公众号