Python API 完整指南｜使用方法、開發流程與部署教學全解析

1. 前言

1.1 什麼是 API？

• 資料取得：例如社群平台貼文、天氣預報、股票資訊等
• 資料傳送：像是使用者註冊、表單送出、付款處理等
• 系統整合：將不同的應用或服務進行串接

1.2 使用 Python 操作與建立 API 的優勢

1.2.1 使用簡單的程式碼呼叫 API

import requests

response = requests.get("https://api.example.com/data")
print(response.json())  # 顯示取得的資料

1.2.2 可使用功能強大的 Web 框架

• Flask：輕量、簡單，適合新手快速建立 API。
• FastAPI：活用 Python 的型別提示，打造高速且安全的 API。

1.2.3 擁有豐富的函式庫與擴充性

• requests：簡化 API 通訊
• json：處理 API 回應中的 JSON 格式資料
• Flask / FastAPI：用來建立 API 的 Web 框架
• SQLAlchemy：將 API 與資料庫連接的 ORM 工具

1.3 本文將學到的內容

• 使用 Python 呼叫 API 的方法
• 使用 requests 進行 API 請求
• 處理 API 回應（JSON 解析）
• 實作錯誤處理
• 使用 Python 建立 API 的方法
• 使用 Flask / FastAPI 建立 Web API
• 與資料庫的整合
• 實作身份驗證與安全性
• Python API 的實務應用
• 部署至雲端平台（Heroku、AWS Lambda）
• 效能優化方法

2. 如何使用 Python 呼叫 API【新手向】

• 如何使用 Python 呼叫 API
• 使用 requests 函式庫發送 HTTP 請求
• 如何處理 API 的回應
• 錯誤處理與因應方式

3. 如何使用 Python 建立 API【Flask 與 FastAPI】

• 建立 Web API 的基本流程
• 使用 Flask 建立簡單 API
• 使用 FastAPI 建立高效能 API
• 與資料庫整合
• API 的安全性對策

3.1 如何建立 Web API？

1. 選擇框架（如 Flask 或 FastAPI）
2. 設計 API 的端點（決定 URL 與資料內容）
3. 定義請求與回應（使用 JSON 來傳遞資料）
4. 與資料庫連接（可使用 SQL 或 NoSQL）
5. 實施驗證與安全措施（如 API 金鑰或 JWT）

3.2 使用 Flask 建立簡單的 API

3.2.1 安裝 Flask

pip install flask

3.2.2 使用 Flask 建立基本 API

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/api/hello', methods=['GET'])
def hello():
    return jsonify({"message": "Hello, World!"})

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

程式碼說明

1. 建立 Flask 實例
2. 使用 @app.route 定義 API 路徑
3. 使用 jsonify() 回傳 JSON 格式資料
4. 執行 app.run(debug=True) 啟動本機伺服器

3.3 使用 FastAPI 建立高效能 API

3.3.1 安裝 FastAPI

pip install fastapi uvicorn

3.3.2 使用 FastAPI 建立簡單 API

from fastapi import FastAPI

app = FastAPI()

@app.get("/api/hello")
def hello():
    return {"message": "Hello, FastAPI!"}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8000)

3.4 與資料庫整合

3.4.1 使用 SQLite 與 SQLAlchemy

pip install sqlalchemy sqlite

from flask import Flask, jsonify
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///test.db"
db = SQLAlchemy(app)

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(80), nullable=False)

@app.route("/api/users", methods=["GET"])
def get_users():
    users = User.query.all()
    return jsonify([{"id": user.id, "name": user.name} for user in users])

if __name__ == "__main__":
    db.create_all()
    app.run(debug=True)

3.5 API 的安全性對策

3.5.1 加入認證與授權機制

• 使用 API 金鑰：限制存取 API 的權限
• 使用 JWT（JSON Web Token）：強化使用者驗證

3.5.2 驗證資料格式

from pydantic import BaseModel
from fastapi import FastAPI

app = FastAPI()

class UserRequest(BaseModel):
    name: str
    age: int

@app.post("/api/users")
def create_user(user: UserRequest):
    return {"message": f"{user.name}（{user.age}歲）已註冊成功"}

小結

• 使用 Flask 建立簡單 API
• 使用 FastAPI 建立高效能 API
• 透過 SQLAlchemy 整合資料庫
• 強化 API 的安全性（驗證與資料檢查）

4. 如何部署 Python API

• 在本地環境運行 API
• 部署至雲端平台的方法
• 使用 Heroku 部署
• 使用 AWS Lambda 進行無伺服器部署
• API 的效能優化方式

4.1 在本地運行 API

4.1.1 執行 Flask 應用

1. 將 Flask 程式碼儲存為 app.py
2. 在終端機執行下列指令

python app.py

4.1.2 執行 FastAPI 應用

uvicorn main:app --host 127.0.0.1 --port 8000 --reload

4.2 將 API 部署至雲端平台

4.2.1 使用 Heroku 進行部署

Heroku 部署步驟

1. 安裝 Heroku CLI

• 前往官方網站（https://devcenter.heroku.com/articles/heroku-cli）進行安裝

1. 登入 Heroku 帳號

   heroku login

3. 初始化 Git 倉庫

   git init
   heroku create my-python-api

4. 建立必要的檔案

• requirements.txt：列出所需函式庫 flask gunicorn
• Procfile：Heroku 使用的程序定義檔案 web: gunicorn app:app

5. 提交 Git 並部署

   git add .
   git commit -m "Deploy API to Heroku"
   git push heroku main

6. 開啟應用程式網址

   heroku open

4.2.2 使用 AWS Lambda 進行無伺服器部署

AWS Lambda 部署 FastAPI 步驟

1. 安裝 AWS Lambda 所需函式庫

   pip install mangum

2. 建立 FastAPI 應用（main.py）

   from fastapi import FastAPI
   from mangum import Mangum

   app = FastAPI()

   @app.get("/")
   def hello():
       return {"message": "Hello from AWS Lambda"}

   handler = Mangum(app)

3. 部署至 AWS Lambda

• 可透過 AWS API Gateway 整合
• 使用 AWS CLI 或網頁控制台上傳

4.3 提升 API 效能的方法

4.3.1 使用快取（Cache）機制

• Flask 範例：

  from flask_caching import Cache

  cache = Cache(app, config={'CACHE_TYPE': 'simple'})

  @app.route('/data')
  @cache.cached(timeout=60)  # 快取 60 秒
  def get_data():
      return {"message": "Cached data"}

• FastAPI 範例：

  from fastapi.middleware.cors import CORSMiddleware

  app.add_middleware(
      CORSMiddleware,
      allow_origins=["*"],
      allow_credentials=True,
      allow_methods=["*"],
      allow_headers=["*"],
  )

4.3.2 活用非同步處理

from fastapi import FastAPI

app = FastAPI()

@app.get("/async")
async def async_endpoint():
    return {"message": "This is an async endpoint"}

4.3.3 使用負載平衡（Load Balancing）

• 在 AWS 中使用 Elastic Load Balancer（ELB）
• Heroku 中可使用 Auto Scaling

小結

• 在本地測試 API
• 使用 Heroku 快速部署
• 透過 AWS Lambda 進行無伺服器部署
• API 效能優化技巧（快取、非同步、負載平衡）

5. Python API 常見問題（FAQ）

5.1 有哪些免費的 API 可以用來測試 Python？

5.2 Web 爬蟲與 API 有什麼不同？

5.3 如何安全地管理 API 金鑰？

5.3.1 使用環境變數儲存金鑰

export API_KEY="your-secret-api-key"

import os

api_key = os.getenv("API_KEY")
print(f"API 金鑰: {api_key}")

5.3.2 使用 .env 檔案

   API_KEY=your-secret-api-key

   pip install python-dotenv

   from dotenv import load_dotenv
   import os

   load_dotenv()
   api_key = os.getenv("API_KEY")
   print(f"API 金鑰: {api_key}")

5.4 Flask 與 FastAPI 有何差異？

5.5 如何提升 API 效能？

5.5.1 快取（Cache）

• Flask 範例：

from flask_caching import Cache

cache = Cache(app, config={'CACHE_TYPE': 'simple'})

@app.route('/data')
@cache.cached(timeout=60)
def get_data():
    return {"message": "Cached data"}

• FastAPI 範例：

from fastapi.middleware.cors import CORSMiddleware

app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

5.5.2 使用 async 非同步處理

from fastapi import FastAPI

app = FastAPI()

@app.get("/async")
async def async_endpoint():
    return {"message": "This is an async endpoint"}

5.5.3 使用負載平衡

• AWS Elastic Load Balancer（ELB）
• Heroku Auto Scaling
• Nginx 作為反向代理伺服器

小結

• 免費的測試 API
• Web 爬蟲與 API 的比較
• 安全地管理 API 金鑰的方法
• Flask 與 FastAPI 的差異
• API 效能優化技巧