如何使用Pyramid和Cornice编写Python Web API
使用 Pyramid 和 Cornice 构建和描述可扩展的 RESTful Web 服务。
Python 是一种高级的、面向对象的编程语言,它以其简单的语法而闻名。它一直是构建 RESTful API 的顶级编程语言之一。
Pyramid 是一个 Python Web 框架,旨在随着应用的扩展而扩展:这可以让简单的应用很简单,也可以增长为大型、复杂的应用。此外,Pyramid 为 PyPI (Python 软件包索引)提供了强大的支持。Cornice 为使用 Pyramid 构建和描述 RESTful Web 服务提供了助力。
本文将使用 Web 服务的例子来获取名人名言,来展示如何使用这些工具。
建立 Pyramid 应用
首先为你的应用创建一个虚拟环境,并创建一个文件来保存代码:
$ mkdir tutorial $ cd tutorial $ touch main.py $ python3 -m venv env $ source env/bin/activate (env) $ pip3 install cornice twisted
导入 Cornice 和 Pyramid 模块
使用以下命令导入这些模块:
from pyramid.config import Configurator from cornice import Service
定义服务
将引用服务定义为 Service
对象:
QUOTES = Service(name='quotes', path='/', description='Get quotes')
编写引用逻辑
到目前为止,这仅支持获取名言。用 QUOTES.get
装饰函数。这是将逻辑绑定到 REST 服务的方法:
@QUOTES.get() def get_quote(request): return { 'William Shakespeare': { 'quote': ['Love all, trust a few, do wrong to none', 'Some are born great, some achieve greatness, and some have greatness thrust upon them.'] }, 'Linus': { 'quote': ['Talk is cheap. Show me the code.'] } }
请注意,与其他框架不同,装饰器不会更改 get_quote
函数。如果导入此模块,你仍然可以定期调用该函数并检查结果。
在为 Pyramid RESTful 服务编写单元测试时,这很有用。
定义应用对象
最后,使用 scan
查找所有修饰的函数并将其添加到配置中:
with Configurator() as config: config.include("cornice") config.scan() application = config.make_wsgi_app()
默认扫描当前模块。如果要扫描软件包中的所有模块,你也可以提供软件包的名称。
运行服务
我使用 Twisted 的 WSGI 服务器运行该应用,但是如果需要,你可以使用任何其他 WSGI 服务器,例如 Gunicorn 或 uWSGI。
(env)$ python -m twisted web --wsgi=main.application
默认情况下,Twisted 的 WSGI 服务器运行在端口 8080 上。你可以使用 HTTPie 测试该服务:
(env) $ pip install httpie ... (env) $ http GET <http://localhost:8080/> HTTP/1.1 200 OK Content-Length: 220 Content-Type: application/json Date: Mon, 02 Dec 2019 16:49:27 GMT Server: TwistedWeb/19.10.0 X-Content-Type-Options: nosniff { "Linus": { "quote": [ "Talk is cheap. Show me the code." ] }, "William Shakespeare": { "quote": [ "Love all,trust a few,do wrong to none", "Some are born great, some achieve greatness, and some greatness thrust upon them." ] } }