如何使用Flask編寫(xiě)Python Web API
這是一個(gè)快速教程,用來(lái)展示如何通過(guò) Flask(目前發(fā)展最迅速的 Python 框架之一)來(lái)從服務(wù)器獲取數(shù)據(jù)。
Python 是一個(gè)以語(yǔ)法簡(jiǎn)潔著稱(chēng)的高級(jí)的、面向?qū)ο蟮某绦蛘Z(yǔ)言。它一直都是一個(gè)用來(lái)構(gòu)建 RESTful API 的頂級(jí)編程語(yǔ)言。
Flask 是一個(gè)高度可定制化的 Python 框架,可以為開(kāi)發(fā)人員提供用戶(hù)訪(fǎng)問(wèn)數(shù)據(jù)方式的完全控制。Flask 是一個(gè)基于 Werkzeug 的 WSGI 工具包和 Jinja 2 模板引擎的”微框架“。它是一個(gè)被設(shè)計(jì)來(lái)開(kāi)發(fā) RESTful API 的 web 框架。
Flask 是 Python 發(fā)展最迅速的框架之一,很多知名網(wǎng)站如:Netflix、Pinterest 和 LinkedIn 都將 Flask 納入了它們的開(kāi)發(fā)技術(shù)棧。下面是一個(gè)簡(jiǎn)單的示例,展示了 Flask 是如何允許用戶(hù)通過(guò) HTTP GET 請(qǐng)求來(lái)從服務(wù)器獲取數(shù)據(jù)的。
初始化一個(gè) Flask 應(yīng)用
首先,創(chuàng)建一個(gè)你的 Flask 項(xiàng)目的目錄結(jié)構(gòu)。你可以在你系統(tǒng)的任何地方來(lái)做這件事。
$ mkdir tutorial
$ cd tutorial
$ touch main.py
$ python3 -m venv env
$ source env/bin/activate
(env) $ pip3 install flask-restful
Collecting flask-restful
Downloading https://files.pythonhosted.org/packages/17/44/6e49...8da4/Flask_RESTful-0.3.7-py2.py3-none-any.whl
Collecting Flask>=0.8 (from flask-restful)
[...]
導(dǎo)入 Flask 模塊
然后,在你的 main.py
代碼中導(dǎo)入 flask
模塊和它的 flask_restful
庫(kù):
from flask import Flask
from flask_restful import Resource, Api
app = Flask(__name__)
api = Api(app)
class Quotes(Resource):
def get(self):
return {
'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.']
},
'Linus': {
'quote': ['Talk is cheap. Show me the code.']
}
}
api.add_resource(Quotes, '/')
if __name__ == '__main__':
app.run(debug=True)
運(yùn)行 app
Flask 包含一個(gè)內(nèi)建的用于測(cè)試的 HTTP 服務(wù)器。來(lái)測(cè)試一下這個(gè)你創(chuàng)建的簡(jiǎn)單的 API:
(env) $ python main.py
* Serving Flask app "main" (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
啟動(dòng)開(kāi)發(fā)服務(wù)器時(shí)將啟動(dòng) Flask 應(yīng)用程序,該應(yīng)用程序包含一個(gè)名為 get
的方法來(lái)響應(yīng)簡(jiǎn)單的 HTTP GET 請(qǐng)求。你可以通過(guò) wget
、curl
命令或者任意的 web 瀏覽器來(lái)測(cè)試它。
$ curl http://localhost:5000
{
"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."
]
},
"Linus": {
"quote": [
"Talk is cheap. Show me the code."
]
}
}
要查看使用 Python 和 Flask 的類(lèi)似 Web API 的更復(fù)雜版本,請(qǐng)導(dǎo)航至美國(guó)國(guó)會(huì)圖書(shū)館的 Chronicling America 網(wǎng)站,該網(wǎng)站可提供有關(guān)這些信息的歷史報(bào)紙和數(shù)字化報(bào)紙。
為什么使用 Flask?
Flask 有以下幾個(gè)主要的優(yōu)點(diǎn):
- Python 很流行并且廣泛被應(yīng)用,所以任何熟悉 Python 的人都可以使用 Flask 來(lái)開(kāi)發(fā)。
- 它輕巧而簡(jiǎn)約。
- 考慮安全性而構(gòu)建。
- 出色的文檔,其中包含大量清晰,有效的示例代碼。
還有一些潛在的缺點(diǎn):
- 它輕巧而簡(jiǎn)約。但如果你正在尋找具有大量捆綁庫(kù)和預(yù)制組件的框架,那么這可能不是最佳選擇。
- 如果必須圍繞 Flask 構(gòu)建自己的框架,則你可能會(huì)發(fā)現(xiàn)維護(hù)自定義項(xiàng)的成本可能會(huì)抵消使用 Flask 的好處。
如果你要構(gòu)建 Web 程序或 API,可以考慮選擇 Flask。它功能強(qiáng)大且健壯,并且其優(yōu)秀的項(xiàng)目文檔使入門(mén)變得容易。試用一下,評(píng)估一下,看看它是否適合你的項(xiàng)目。
在本課中了解更多信息關(guān)于 Python 異常處理以及如何以安全的方式進(jìn)行操作。