如何編寫簡單的 Flask “Hello World” API?


Flask 是一個用 Python 編寫的輕量級 Web 框架,允許開發者快速構建 Web 應用程式和 API。它提供了一種簡單優雅的方法來建立 RESTful API,只需少量程式碼。在本文中,我們將逐步介紹建立一個簡單的 Flask API 的過程,該 API 返回“Hello, World!”訊息。

先決條件

在開始之前,請確保您的機器上已安裝以下內容:

  • Python(3.6 版或更高版本)

  • Flask(可以使用 pip 安裝)

演算法

編寫任何簡單的 Flask API 的通用演算法如下:

  • 設定 Flask 環境

    • 為您的專案建立一個新目錄。

    • 在您的終端或命令提示符中導航到專案目錄。

  • 建立虛擬環境

    • 使用命令 `python3 -m venv venv` 建立虛擬環境。

    • 根據您的作業系統使用相應的命令啟用虛擬環境。

  • 安裝 Flask

    • 使用命令 `pip install flask` 在虛擬環境中安裝 Flask。

  • 編寫 Flask API 程式碼

    • 在您的專案目錄中建立一個 Python 檔案,例如 app.py。

    • 匯入 Flask 模組。

    • 使用 `app = Flask(__name__)` 建立 Flask 應用程式例項。

    • 使用 `@app.route` 裝飾器定義路由。對於“Hello, World!” API,請使用 `@app.route('/')`。

    • 建立一個函式,例如 `hello_world()`,幷包含所需的響應。

    • 確保存在 `if __name__ == '__main__':` 條件,這允許在直接執行指令碼時執行伺服器。

  • 執行 Flask API

    • 儲存 app.py 檔案。

    • 確保您在啟用虛擬環境的專案目錄中。

    • 使用命令 `python app.py` 啟動 Flask 開發伺服器。

  • 測試 Flask API

    • 開啟 Web 瀏覽器或 Postman 等工具。

    • 訪問 `http://127.0.0.1:5000/` 以檢視“Hello, World!”訊息。

  • 進一步開發

    • 探索其他 Flask 功能和擴充套件以增強 API 的功能。

    • 在構建更高階的 API 時,請考慮安全措施、最佳實踐和可擴充套件性。

建立簡單的 Flask API 的步驟

步驟 1:設定 Flask 環境

首先,讓我們為專案建立一個新目錄。開啟您的終端或命令提示符並導航到所需位置。使用以下命令建立一個新目錄:

mkdir flask-api-hello-world

建立目錄後,使用以下命令移動到專案目錄:

cd flask-api-hello-world

步驟 2:建立虛擬環境

建議在虛擬環境中工作,以避免不同專案依賴項之間的衝突。使用以下命令建立虛擬環境:

python3 -m venv venv

啟用虛擬環境

在 macOS/Linux 上

source venv/bin/activate

在 Windows 上

venv\Scripts\activate

步驟 3:安裝 Flask

進入虛擬環境後,我們可以使用 pip 安裝 Flask:

Pip install flask

步驟 4:編寫 Flask API

現在,讓我們建立一個名為 app.py 的 Python 檔案,並在您喜歡的文字編輯器中開啟它。新增以下程式碼以建立一個基本的 Flask API:

示例

在下面的程式碼示例中,我們匯入 Flask 模組,建立一個 Flask Web 應用程式例項,並使用 `@app.route` 裝飾器定義路由。`/` 路由對應於 API 的根 URL。當向此 URL 發出請求時,將執行 `hello_world` 函式,返回字串“Hello, World!”。

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run()

步驟 5:執行 Flask API

儲存 app.py 檔案並返回您的終端或命令提示符。確保您仍在專案目錄中並且您的虛擬環境處於活動狀態。使用以下命令啟動 Flask 開發伺服器:

python app.py

輸出

如果一切設定正確,您應該會看到類似於以下內容的輸出:

 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

步驟 6:測試 Flask API

開啟 Web 瀏覽器或 Postman 等工具,然後導航到 `http://127.0.0.1:5000/`。您應該會看到“Hello, World!”訊息顯示在您的瀏覽器中或作為 Postman 中的響應。

結論

在本文中,我們討論了構建返回“Hello, World!”訊息的簡單 Flask API 的過程。我們介紹了必要的步驟,從設定 Flask 環境和建立虛擬環境到編寫程式碼和執行 Flask 開發伺服器。按照這些步驟,您現在應該對如何建立簡單的 Flask API 有了基本的瞭解。

更新於:2023年10月16日

415 次瀏覽

啟動您的職業生涯

完成課程獲得認證

開始
廣告
© . All rights reserved.