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

网友投稿 285 2023-05-25

[[313078]]

使用 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 twisted1.2.3.4.5.6.

导入 Cornice 和 Pyramid 模块

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

复制from pyramid.config importConfiguratorfrom cornice importService1.2.

定义服务

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

复制QUOTES =Service(name=quotes,                 path=/,                 description=Get quotes)1.2.3.

编写引用逻辑

到目前为止,这仅支持获取名言。用 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.]}}1.2.3.4.5.6.7.8.9.10.11.

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

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

定义应用对象

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

复制withConfigurator()as config:    config.include("cornice")    config.scan()    application = config.make_wsgi_app()1.2.3.4.

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

运行服务

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

复制(env)$ python -m twisted web --wsgi=main.application1.

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

复制(env) $ pip install httpie...(env) $ http GET <http://localhost:8080/>HTTP/1.1200 OKContent-Length:220Content-Type: application/jsonDate:Mon,02Dec201916:49:27 GMTServer:TwistedWeb/19.10.0X-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."]}}1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16.17.18.19.20.21.22.23.

为什么要使用 Pyramid?

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

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

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:让短信验证码自动输入,让生活更智能!
下一篇:轻松愉悦的生活从自动过验证码开始
相关文章

 发表评论

暂时没有评论,来抢沙发吧~