文章

Flask - 環境設置與第一個 Flask 應用

目標

  • 安裝必要的工具和庫
  • 創建一個簡單的 Flask 應用
  • 運行並測試第一個 API 端點

步驟

  1. 設置環境
    • 安裝 Python
      確保您的系統已安裝 Python 3.8 或更高版本。您可以在終端運行以下命令檢查版本:
      1
      
      python --version
      

      如果未安裝,請從 python.org 下載並安裝。

    • 創建虛擬環境
      虛擬環境可以隔離項目依賴,避免衝突。在終端運行:
      1
      
      python -m venv flask_api_env
      

      激活虛擬環境:

      • Windows: flask_api_env\Scripts\activate
      • macOS/Linux: source flask_api_env/bin/activate 激活後,您的終端提示符前會顯示 (flask_api_env)
    • 安裝 Flask
      在虛擬環境中安裝 Flask:
      1
      
      pip install flask
      
  2. 創建第一個 Flask 應用
    • 在您的工作目錄中創建一個文件 app.py,並輸入以下代碼:
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      
      from flask import Flask
      
      app = Flask(__name__)
      
      @app.route('/')
      def hello_world():
          return 'Hello, World!'
      
      if __name__ == '__main__':
          app.run(debug=True)
      
    • 代碼解釋:
      • Flask(__name__):創建 Flask 應用實例。
      • @app.route('/'):定義一個路由,訪問根路徑 (/) 時觸發。
      • app.run(debug=True):啟動開發服務器,啟用調試模式。
  3. 運行應用
    • 在終端中運行:
      1
      
      python app.py
      
    • 您應該看到類似以下輸出: ```
      • Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) ```
    • 打開瀏覽器,訪問 http://127.0.0.1:5000/,您將看到 “Hello, World!”。
  4. 測試第一個 API 端點
    • 修改 app.py,添加一個簡單的 JSON API 端點:
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      
      from flask import Flask, jsonify
      
      app = Flask(__name__)
      
      @app.route('/')
      def hello_world():
          return 'Hello, World!'
      
      @app.route('/api', methods=['GET'])
      def get_message():
          return jsonify({'message': 'Welcome to Flask API!'})
      
      if __name__ == '__main__':
          app.run(debug=True)
      
    • 保存並重新運行 python app.py
    • 在瀏覽器或使用工具(如 Postman)訪問 http://127.0.0.1:5000/api,您將看到:
      1
      
      {"message": "Welcome to Flask API!"}
      
  5. 作業
    • 嘗試修改 /api 端點的返回數據,例如添加更多的鍵值對(如 {"message": "Hello", "status": "success"})。
    • 使用 Postman(可選)發送 GET 請求並檢查響應。

工具建議

  • 編輯器:推薦使用 VS Code,安裝 Python 插件。
  • 測試工具:下載 Postman,用於測試 API。

遇到問題?

  • 如果 pip install flask 失敗,檢查是否激活虛擬環境。
  • 如果服務器未啟動,確認端口 5000 未被占用。
本文章以 CC BY 4.0 授權