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

なぜ FastAPI なのか？

最初のアプリケーション

FastAPI と Django の違い

GET 操作

Hello world

Hello who?

POST操作

Pydantic モデル

POST の実行例

FastAPIの基本

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

PUT と DELETE の操作

from fastapi import FastAPI
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    ____: str
    ____: str

# Define items at application start
items = {"bananas": "Yellow fruit."}

app = FastAPI()


@app.put("/items")
def update_item(item: Item):
    name = item.name
    # Update the description
    items[____] = item.____
    return item

from fastapi import FastAPI
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    name: str
    description: str

# Define items at application startup
items = {"bananas": "Yellow fruit."}

app = FastAPI()


@app.put("/items")
def update_item(item: Item):
    name = item.name
    # Update the description
    items[name] = item.description
    return item

PUT 操作を実装する

from fastapi import FastAPI
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    ____: str

# Define items at application start
items = {"apples", "oranges", "bananas"}

app = FastAPI()


@app.delete("/items")
def delete_item(item: Item):
    name = item.name
    # Delete the item
    items.remove(____)
    return {}

from fastapi import FastAPI
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    name: str

# Define items at application startup
items = {"apples", "oranges", "bananas"}

app = FastAPI()


@app.delete("/items")
def delete_item(item: Item):
    name = item.name
    # Delete the item
    items.remove(name)
    return {}

DELETE の実装を試す

エラー処理

オプション

成功

成功ではない

ステータスコードの分類

from fastapi import FastAPI, ____
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    name: str

# Define items at application startup
items = {"apples", "oranges"}

app = FastAPI()


@app.delete("/items")
def delete_item(item: Item):
    name = item.name
    if name in items:
        items.remove(name)
    else:
        # Raise HTTPException with status code for "not found"
        raise ____(status_code=____, detail="Item not found.")
    return {}

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    name: str

# Define items at application startup
items = {"apples", "oranges"}

app = FastAPI()


@app.delete("/items")
def delete_item(item: Item):
    name = item.name
    if name in items:
        items.remove(name)
    else:
        # Raise HTTPException with status code for "not found"
        raise HTTPException(status_code=404, detail="Item not found.")
    return {}

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

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

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

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    name: str

app = FastAPI()

items = {"rock", "paper", "scissors"}


@app.delete("/items")
# Make asynchronous
____ def root(item: Item):
    name = item.name
    # Check if name is in items
    if ____ not in ____:
        # Return the status code for not found
        raise HTTPException(status_code=___, detail="Item not found.")
    items.remove(name)
    return {"message": "Item deleted"}

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

# Define model Item
class Item(BaseModel):
    name: str

app = FastAPI()

items = {"rock", "paper", "scissors"}


@app.delete("/items")
# Make asynchronous
async def root(item: Item):
    name = item.name
    # Check if name is in items
    if name not in items:
        # Return the status code for not found
        raise HTTPException(status_code=404, detail="Item not found.")
    items.remove(name)
    return {"message": "Item deleted"}

非同期のDELETE操作

FastAPIの発展トピック

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

FastAPI の自動テスト

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

システムテスト

JSON CRUD API を構築する

HTTP 操作と CRUD の対応

DELETE 操作のレスポンス

JSON CRUD API を完成させる

手動の機能テストを書く

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

機能テスト

まとめ

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パイプラインを実現。

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

FastAPI入門

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