如何使用 Flask 編寫 Python Web API

如何使用 Flask 編寫 Python Web API

這是一個快速教程,用來展示如何通過 Flask(目前發展最迅速的 Python 框架之一)來從服務器獲取數據。-- Rachel Waston(作者)


Python 是一個以語法簡潔著稱的高級的、面向對象的程序語言。它一直都是一個用來構建 RESTful API 的頂級編程語言。

Flask 是一個高度可定製化的 Python 框架,可以為開發人員提供用戶訪問數據方式的完全控制。Flask 是一個基於 Werkzeug 的 WSGI 工具包和 Jinja 2 模板引擎的”微框架“。它是一個被設計來開發 RESTful API 的 web 框架。

Flask 是 Python 發展最迅速的框架之一,很多知名網站如:Netflix、Pinterest 和 LinkedIn 都將 Flask 納入了它們的開發技術棧。下面是一個簡單的示例,展示了 Flask 是如何允許用戶通過 HTTP GET 請求來從服務器獲取數據的。

初始化一個 Flask 應用

首先,創建一個你的 Flask 項目的目錄結構。你可以在你係統的任何地方來做這件事。

<code>$ 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)
[...]/<code>

導入 Flask 模塊

然後,在你的 main.py 代碼中導入 flask 模塊和它的 flask_restful 庫:

<code>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)/<code>

運行 app

Flask 包含一個內建的用於測試的 HTTP 服務器。來測試一下這個你創建的簡單的 API:

<code>(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)/<code>

啟動開發服務器時將啟動 Flask 應用程序,該應用程序包含一個名為 get 的方法來響應簡單的 HTTP GET 請求。你可以通過 wget、curl 命令或者任意的 web 瀏覽器來測試它。

<code>$ 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."
]
}
}/<code>

要查看使用 Python 和 Flask 的類似 Web API 的更復雜版本,請導航至美國國會圖書館的 Chronicling America 網站,該網站可提供有關這些信息的歷史報紙和數字化報紙。

為什麼使用 Flask?

Flask 有以下幾個主要的優點:

  1. Python 很流行並且廣泛被應用,所以任何熟悉 Python 的人都可以使用 Flask 來開發。
  2. 它輕巧而簡約。
  3. 考慮安全性而構建。
  4. 出色的文檔,其中包含大量清晰,有效的示例代碼。

還有一些潛在的缺點:

  1. 它輕巧而簡約。但如果你正在尋找具有大量捆綁庫和預製組件的框架,那麼這可能不是最佳選擇。
  2. 如果必須圍繞 Flask 構建自己的框架,則你可能會發現維護自定義項的成本可能會抵消使用 Flask 的好處。

如果你要構建 Web 程序或 API,可以考慮選擇 Flask。它功能強大且健壯,並且其優秀的項目文檔使入門變得容易。試用一下,評估一下,看看它是否適合你的項目。

在本課中瞭解更多信息關於 Python 異常處理以及如何以安全的方式進行操作。


via: https://opensource.com/article/19/11/python-web-api-flask

作者: Rachel Waston 選題: lujun9972 譯者: hj24 校對: wxy

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


分享到:


相關文章: