如何使用 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."
        ]
    }
}
複製代碼

爲何要使用 Pyramid？

Pyramid 並非最受歡迎的框架，但它已在 PyPI 等一些引人注目的項目中使用。我喜歡 Pyramid，由於它是認真對待單元測試的框架之一：由於裝飾器不會修改函數而且沒有線程局部變量，因此能夠直接從單元測試中調用函數。例如，須要訪問數據庫的函數將從經過 request.config 傳遞的 request.config 對象中獲取它。這容許單元測試人員將模擬（或真實）數據庫對象放入請求中，而不用仔細設置全局變量、線程局部變量或其餘特定於框架的東西。

若是你正在尋找一個通過測試的庫來構建你接下來的 API，請嘗試使用 Pyramid。你不會失望的。

---

via: opensource.com/article/20/…

做者：Moshe Zadka 選題：lujun9972 譯者：geekpi 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出