まず、FastAPIの主な機能と代表的なユースケースを学びます。次に、最初のアプリケーションを起動して動作を確認しましょう。最後に、リクエストパラメータを含むGETとPOSTの詳細を学び、それらのエンドポイントを構築してテストします。

なぜ FastAPI なのか？

最初のアプリケーション

FastAPI と Django の違い

GET 操作

Hello world

Hello who?

POST操作

Pydantic モデル

POST の実行例

FastAPIの基本

まず、FastAPIでPUTとDELETE操作に対応する方法を学びます。次に、さまざまな種類のエラーを処理し、常に適切なステータスコードをレスポンスで返す方法を学びます。最後に、asyncを使って同時実行を可能にし、より高い負荷に対応する方法を学びます。

PUT と DELETE の操作

PUT 操作を実装する

DELETE の実装を試す

エラー処理

ステータスコードの分類

クライアントエラーの処理

非同期処理で同時実行を行う

async はいつ使うべきですか？

非同期のDELETE操作

FastAPIの発展トピック

まず、個々のFastAPIエンドポイントを検証するシステムテストの書き方を学びます。次に、HTTP上でオブジェクトのライフサイクルを管理する、完全なJSON CRUD APIを構築します。最後に、手動の機能テストで、アプリケーションの異なるエンドポイント同士が連携して動作することを検証します。

FastAPI の自動テスト

オプション

ユニットテスト

システムテスト

ユニットテスト vs. システムテスト

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from typing import Optional

# define model Item
class Item(BaseModel):
    name: str
    quantity: Optional[int] = 0

app = FastAPI()

items = {"scissors": Item(name="scissors", quantity=100)}


@app.get("/items")
def read(name: str):
    if name not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    return items[name]

# Import TestClient
from fastapi.testclient import ____
from main import app

# Create test client with application context
client = TestClient(____)

def test_main():
    response = client.get("/items?name=scissors")
    assert response.status_code == 200
    assert response.json() == {"name": "scissors",
                               "quantity": ____}

# Import TestClient
from fastapi.testclient import TestClient
from main import app

# Create test client with application context
client = TestClient(app)

def test_main():
    response = client.get("/items?name=scissors")
    assert response.status_code == 200
    assert response.json() == {"name": "scissors",
                               "quantity": 100}

JSON CRUD API を構築する

Options

Create

Read

Update

HTTP 操作と CRUD の対応

DELETE 操作のレスポンス

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from typing import Optional

# define model Item
class Item(BaseModel):
    name: str
    quantity: Optional[int] = 0

app = FastAPI()

items = {}


@app.____("/items")
def create(item: Item):
    name = item.name
    if name in items:
        raise HTTPException(status_code=409, detail="Item exists")
    items[name] = item
    return {"message": f"Added {name} to items."}
  
@app.____("/items")
def read(name: str):
    if name not in items:
        raise HTTPException(status_code=____, detail="Item not found")
    return items[name]  
  
@app.____("/items")
def update(item: Item):
    name = item.name
    if name not in items:
        raise HTTPException(status_code=____, detail="Item not found")
    items[name] = item
    return {"message": f"Updated {name}."}
  
@app.delete("/items")
def delete(item: Item):
    name = item.name
    if name not in items:
        raise HTTPException(status_code=____, detail="Item not found")
    del items[name]
    return {"message": f"Deleted {name}."}

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from typing import Optional

# define model Item
class Item(BaseModel):
    name: str
    quantity: Optional[int] = 0

app = FastAPI()

items = {}


@app.post("/items")
def create(item: Item):
    name = item.name
    if name in items:
        raise HTTPException(status_code=409, detail="Item exists")
    items[name] = item
    return {"message": f"Added {name} to items."}
  
@app.get("/items")
def read(name: str):
    if name not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    return items[name]  
  
@app.put("/items")
def update(item: Item):
    name = item.name
    if name not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    items[name] = item
    return {"message": f"Updated {name}."}
  
@app.delete("/items")
def delete(item: Item):
    name = item.name
    if name not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    del items[name]
    return {"message": f"Deleted {name}."}

JSON CRUD API を完成させる

手動の機能テストを書く

機能テスト

システムテスト vs. 機能テスト

import requests

ENDPOINT = "http://localhost:8000/items"

# Create item "rock" without providing quantity
r = requests.post(ENDPOINT, json={"name": "rock"})
assert r.status_code == ____
assert r.json()["message"] == "Added rock to items."

# Verify that item "rock" has quantity 0
r = requests.get(ENDPOINT + "?____=____")
assert r.status_code == 200
assert r.json()["quantity"] == 0

# Update item "rock" with quantity 100
r = requests.put(ENDPOINT, json={"name": "rock", "quantity": 100})
assert r.status_code == 200
assert r.json()["message"] == "Updated rock."

# Verify that item "rock" has quantity 100
r = requests.get(ENDPOINT + "?name=rock")
assert r.status_code == 200
assert r.json()["quantity"] == ____

# Delete item "rock"
r = requests.delete(ENDPOINT, json={____: ____})
assert r.status_code == 200
assert r.json()["message"] == "Deleted rock."

# Verify that item "rock" does not exist
r = requests.get(ENDPOINT + "?name=rock")
assert r.status_code == ____

print("Test complete.")

import requests

ENDPOINT = "http://localhost:8000/items"

# Create item "rock" without providing quantity
r = requests.post(ENDPOINT, json={"name": "rock"})
assert r.status_code == 200
assert r.json()["message"] == "Added rock to items."

# Verify that item "rock" has quantity 0
r = requests.get(ENDPOINT + "?name=rock")
assert r.status_code == 200
assert r.json()["quantity"] == 0

# Update item "rock" with quantity 100
r = requests.put(ENDPOINT, json={"name": "rock", "quantity": 100})
assert r.status_code == 200
assert r.json()["message"] == "Updated rock."

# Verify that item "rock" has quantity 100
r = requests.get(ENDPOINT + "?name=rock")
assert r.status_code == 200
assert r.json()["quantity"] == 100

# Delete item "rock"
r = requests.delete(ENDPOINT, json={"name": "rock"})
assert r.status_code == 200
assert r.json()["message"] == "Deleted rock."

# Verify that item "rock" does not exist
r = requests.get(ENDPOINT + "?name=rock")
assert r.status_code == 404

print("Test complete.")

まとめ

JSON CRUD APIの構築とテスト

本コースでは、API作成のための人気のPythonフレームワークであるFastAPIを使って、本番運用レベルのWebアプリケーションを構築する方法を学びます。4つのHTTP操作すべてに対応し、リクエスト／レスポンスのスキーマ定義、APIリクエストの検証、適切なHTTPステータスコードの返却を実装します。さらに、パフォーマンス向上のための非同期コード実行も扱い、最終的にはCRUD APIを開発し、Pythonのrequestsモジュールでワークフローをテストします。経験豊富なPythonプログラマー向けに設計されており、FastAPIでデータを扱うスキルを身につけ、堅牢なデータ管理やMLモデル提供のパイプライン構築に備えます。

Introduction to APIs in Python

Introduction to Object-Oriented Programming in Python

FastAPIで堅牢なAPIを構築し、HTTP操作、検証、非同期実行を習得して効率的なデータとMLパイプラインを作成。

FastAPI入門

FastAPIで堅牢な本番運用APIを構築。HTTP操作、バリデーション、非同期実行を習得し、効率的なデータ／MLパイプラインを実現。

PythonでAPIを構築する

アプリケーションの起動を必要とする

`TestClient` と併用して `pytest` を使用する

ユニットテスト vs. システムテスト

FastAPI入門

実践的なインタラクティブ演習