Merge pull request #17065 from wxy/20200106-How-to-write-a-Python-web-API-with-Pyramid-and-Cornice

PRF&PUB:20200106 How to write a Python web API with Pyramid and Cornice
This commit is contained in:
Xingyu.Wang 2020-01-16 12:32:04 +08:00 committed by GitHub
commit 63e4d88a8e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,20 +1,22 @@
[#]: collector: (lujun9972)
[#]: translator: (geekpi)
[#]: reviewer: ( )
[#]: publisher: ( )
[#]: url: ( )
[#]: reviewer: (wxy)
[#]: publisher: (wxy)
[#]: url: (https://linux.cn/article-11788-1.html)
[#]: subject: (How to write a Python web API with Pyramid and Cornice)
[#]: via: (https://opensource.com/article/20/1/python-web-api-pyramid-cornice)
[#]: author: (Moshe Zadka https://opensource.com/users/moshez)
如何使用 Pyramid 和 Cornice 编写 Python Web API
======
使用 Pyramid 和 Cornice 构建可扩展的 RESTful Web 服务。
![Searching for code][1]
[Python][2] 是一种高级的,面向对象的编程语言,它以其简单的语法而闻名。它一直是构建 RESTful API 的顶级编程语言之一
> 使用 Pyramid 和 Cornice 构建和描述可扩展的 RESTful Web 服务。
[Pyramid][3] 是一个 Python Web 框架旨在随着应用的扩展而扩展这对于简单的应用来说很简单对于大型、复杂的应用也可以做到。Pyramid 为 PyPI Python 软件包索引)提供了强大的支持。[Cornice][4] 提供了使用 Pyramid 构建 RESTful Web 服务的助手。
![](https://img.linux.net.cn/data/attachment/album/202001/16/120352fcgeeccvfgt8sfvc.jpg)
[Python][2] 是一种高级的、面向对象的编程语言,它以其简单的语法而闻名。它一直是构建 RESTful API 的顶级编程语言之一。
[Pyramid][3] 是一个 Python Web 框架旨在随着应用的扩展而扩展这可以让简单的应用很简单也可以增长为大型、复杂的应用。此外Pyramid 为 PyPI Python 软件包索引)提供了强大的支持。[Cornice][4] 为使用 Pyramid 构建和描述 RESTful Web 服务提供了助力。
本文将使用 Web 服务的例子来获取名人名言,来展示如何使用这些工具。
@ -22,7 +24,6 @@
首先为你的应用创建一个虚拟环境,并创建一个文件来保存代码:
```
$ mkdir tutorial
$ cd tutorial
@ -36,7 +37,6 @@ $ source env/bin/activate
使用以下命令导入这些模块:
```
from pyramid.config import Configurator
from cornice import Service
@ -44,8 +44,7 @@ from cornice import Service
### 定义服务
将引用服务定义为 **Service** 对象:
将引用服务定义为 `Service` 对象:
```
QUOTES = Service(name='quotes',
@ -55,8 +54,7 @@ QUOTES = Service(name='quotes',
### 编写引用逻辑
到目前为止,这仅支持 **GET** 获取名言。用 **QUOTES.get** 装饰函数。这是将逻辑绑定到 REST 服务的方法:
到目前为止,这仅支持获取名言。用 `QUOTES.get` 装饰函数。这是将逻辑绑定到 REST 服务的方法:
```
@QUOTES.get()
@ -72,14 +70,13 @@ def get_quote(request):
    }
```
请注意,与其他框架不同,装饰器_不能_更改 **get_quote** 函数。如果导入此模块,你仍然可以定期调用该函数并检查结果。
请注意,与其他框架不同,装饰器*不会*更改 `get_quote` 函数。如果导入此模块,你仍然可以定期调用该函数并检查结果。
在为 Pyramid RESTful 服务编写单元测试时,这很有用。
### 定义应用对象
最后,使用 **scan** 查找所有修饰的函数并将其添加到配置中:
最后,使用 `scan` 查找所有修饰的函数并将其添加到配置中:
```
with Configurator() as config:
@ -94,14 +91,12 @@ with Configurator() as config:
我使用 Twisted 的 WSGI 服务器运行该应用,但是如果需要,你可以使用任何其他 [WSGI][5] 服务器,例如 Gunicorn 或 uWSGI。
```
`(env)$ python -m twisted web --wsgi=main.application`
(env)$ python -m twisted web --wsgi=main.application
```
默认情况下Twisted 的 WSGI 服务器运行在端口 8080 上。你可以使用 [HTTPie][6] 测试该服务:
```
(env) $ pip install httpie
...
@ -130,7 +125,7 @@ X-Content-Type-Options: nosniff
### 为什么要使用 Pyramid
Pyramid 不是最受欢迎的框架,但它已在 [PyPI][7] 等一些引人注目的项目中使用。我喜欢 Pyramid因为它是认真对待单元测试的框架之一因为装饰器不会修改函数并且没有线程局部变量所以可以直接从单元测试中调用函数。例如需要访问数据库的函数将从通过 **request.config** 传递的 **request.config** 对象中获取它。这允许单元测试人员将模拟(或真实)数据库对象放入请求中,而不用仔细设置全局变量线程局部变量或其他特定于框架的东西。
Pyramid 不是最受欢迎的框架,但它已在 [PyPI][7] 等一些引人注目的项目中使用。我喜欢 Pyramid因为它是认真对待单元测试的框架之一因为装饰器不会修改函数并且没有线程局部变量所以可以直接从单元测试中调用函数。例如需要访问数据库的函数将从通过 `request.config` 传递的 `request.config` 对象中获取它。这允许单元测试人员将模拟(或真实)数据库对象放入请求中,而不用仔细设置全局变量线程局部变量或其他特定于框架的东西。
如果你正在寻找一个经过测试的库来构建你接下来的 API请尝试使用 Pyramid。你不会失望的。
@ -140,8 +135,8 @@ via: https://opensource.com/article/20/1/python-web-api-pyramid-cornice
作者:[Moshe Zadka][a]
选题:[lujun9972][b]
译者:[译者ID](https://github.com/译者ID)
校对:[校对者ID](https://github.com/校对者ID)
译者:[geekpi](https://github.com/geekpi)
校对:[wxy](https://github.com/wxy)
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译,[Linux中国](https://linux.cn/) 荣誉推出