ChatGPT先生と挑むFastAPI #1｜FastAPI入門と最初のAPI

STEP1では、そもそもFastAPIとは何かを説明してもらい、そのあとに開発環境を構築してから最初のAPIを作成します。FastAPIでAPIを作ると、APIドキュメントが自動生成されます。このドキュメントをSeagger UIで確認します。

今回学ぶこと

今回のステップで学ぶ内容を一覧で出してもらいました。

1. FastAPIとは何かを理解する
2. Docker / Dev Containersで開発環境を構築する
3. 最初のGET APIを作る
4. FastAPIアプリを起動して動作確認する
5. Swagger UIを確認する
6. 自力課題

学習開始

それでは学習をはじめます。

FastAPIとは何かを理解する

FastAPIとは？

処理の流れは以下のようなイメージになります。

FastAPIを使わずにHTTP通信をPythonだけで一から処理しようとすると、以下のような多くの処理を自分で用意する必要があります。

• URLを判定する
• GETやPOSTを判定する
• パラメータを取得する
• JSONを読み取る
• 入力値をチェックする
• JSONレスポンスを作る
• HTTPステータスコードを設定する

FastAPIは、このようなWeb API開発でよく必要になる処理をフレームワークとして提供してくれます。

そのため、開発者は「このURLにアクセスされたらこの処理を実行してデータを返す」というアプリケーション本来の処理に注力しやすくなります。

FastAPIの大きな特徴

① Pythonの型ヒントを活用する

例えば、次のようなPythonの型情報を、FastAPIがAPIの入力チェックなどにも利用します。

name: str
age: int

② APIドキュメントを自動生成できる

FastAPIでAPIを作ると、Swagger UIの画面から「どんなAPIがあるのか・どんな値を渡すのか・どんな結果が返るのか」を確認できます。

③ 少ないコードでAPIを作れる

最初のAPIは、かなり短いPythonコードで作れます。このあと実際に作ってどのくらいシンプルなのか確認します。

FastAPIの立ち位置

FastAPIは主に外部からHTTPリクエストを受け付けて、Pythonの処理につなぐ入口を担当すると考えると分かりやすいです。

Django REST Frameworkとの違い

実際に使用したことのあるDjango REST Framework（DRF）との違いについても聞いてみました。

まず全体像を比較すると以下のような感じです。

観点	FastAPI	Django REST Framework
ベース	Starlette + Pydantic	Django
主目的	API開発	DjangoでAPI開発
設計思想	APIファースト、型ヒント重視	Djangoの機能を活用したWeb/API開発
コード量	比較的少ない	やや多め
学習コスト	比較的低い	Djangoの知識も必要
型ヒント	非常に重要	必須ではない
入力検証	Pydantic	Serializer
ORM	自由に選択可能	Django ORMとの相性が非常に良い
管理画面	標準ではない	Django Adminが強力
認証・ユーザー管理	自分で構成することが多い	Djangoの認証基盤が充実
APIドキュメント	OpenAPI / Swagger UIを自動生成	構成次第。Browsable APIが特徴
非同期処理	得意	対応しているがFastAPIほど中心ではない

FastAPIは標準Pythonの型ヒントを中心に設計されており、OpenAPIやSwagger UIも標準的に自動生成されます。
DRFはDjango上で動き、Serializer、認証、パーミッション、Browsable APIなどを組み合わせてAPIを構築します。

DRFは単体のフレームワークではありません。DjangoでWebアプリを作っていて、その機能をAPIとして公開したいという状況に非常に強いです。

Django
 ├─ ORM
 ├─ 認証
 ├─ Admin
 ├─ URL Routing
 ├─ Middleware
 └─ Django REST Framework
      ├─ Serializer
      ├─ APIView
      ├─ ViewSet
      └─ API用認証など

一方FastAPIは以下のような感じです。特定のデータベースやフロントエンドに依存せず統合できる設計になっています。

FastAPI
 ├─ Routing
 ├─ Validation
 ├─ Dependency Injection
 ├─ OpenAPI
 └─ Swagger UI

DB
 ↓
SQLAlchemyなどを自由に選ぶ

フレームワーク	メリット	デメリット
FastAPI	・少ないコードでAPIを作りやすい ・Pythonの型ヒントをそのまま活用できる ・Pydanticによる入力値チェックが強力 ・Swagger UI / OpenAPIドキュメントを自動生成できる ・async / awaitを使った非同期処理と相性が良い ・AI、機械学習、データ処理系のAPIと相性が良い ・DBや認証方式などを比較的自由に選べる	・Djangoのような管理画面が標準ではない ・ORMが標準で決められていないため、自分で選択する必要がある ・認証、ユーザー管理などを自分で構成する場面が多い ・自由度が高い分、プロジェクト構成やライブラリ選定に設計判断が必要
DRF	・Djangoの豊富な機能をそのまま利用できる ・Django ORMが強力 ・Django Adminで管理画面を作りやすい ・認証、ユーザー管理、権限管理が充実している ・Serializerによるデータ変換・入力チェックが充実 ・大規模な業務システムやデータモデルが多いシステムと相性が良い ・Djangoの成熟したエコシステムを利用できる	・Django自体の知識も必要になる ・APIだけ作りたい場合にはやや大掛かり ・覚える概念が多い ・FastAPIと比べるとコード量が増えやすい ・非同期APIを中心に設計する場合はFastAPIほど自然ではない

こんな場合	向いている方
AI・LLM用のAPIを作りたい	FastAPI
機械学習モデルをAPI化したい	FastAPI
小〜中規模のAPIをシンプルに作りたい	FastAPI
マイクロサービスを作りたい	FastAPI
React / Next.jsのバックエンドAPIを作りたい	FastAPI
会員・商品・注文などの業務システムを作りたい	DRF
管理画面を簡単に用意したい	DRF
認証・ユーザー・権限管理が重要	DRF
Djangoで既にシステムを作っている	DRF
多数のDBテーブルを扱うWebシステム	DRF

あるいは

Docker / Dev Containersで開発環境を構築する

VS Code自体はWindows側で動きますが、PythonやFastAPIはDev Containerの中で動かします。
つまり、Windowsへ直接ツールやライブラリをインストールするのではなく、プロジェクト専用のLinux環境をDockerで用意します。

DockerとDev Containersの役割の違い

Dockerは、アプリケーションを実行するための隔離された環境（Container）を作る仕組みです。
例えば今回なら以下のようなライブラリが入った専用の環境を作れます。

• Python 3.x
• FastAPI
• uvicorn
• その他ライブラリ

Dev Containersは、Docker ContainerをVS Codeの開発環境として使いやすくする仕組みです。
DockerだけでもContainerは作れますが、Dev Containersを使うことで開発が簡単になります。

PCに直接Pythonを入れていると、以下のように環境が混ざりやすく管理が面倒です。

Dev Containerなら以下のように分離できます。

そして.devcontainer/に環境設定を残しておけば、同じ構成を作り直せます。これは実務でもかなり大きなメリットです。

開発環境を構築

Docker DesktopやVS Codeなどのツールはインストール済みとして進めます。

// 現時点でのディレクトリ構成
fastapi-learning/
└─ requirements.txt     ← 追加

requirements.txtの中身↓

fastapi[standard]
sqlalchemy
alembic
psycopg[binary]
pydantic-settings
pytest
pytest-asyncio
httpx
ruff

ライブラリ	用途
fastapi[standard]	FastAPI本体、Uvicornなど
sqlalchemy	ORM
alembic	DBマイグレーション
psycopg[binary]	PostgreSQL接続
pydantic-settings	環境変数・設定管理
pytest	テスト
pytest-asyncio	async処理のテスト
httpx	APIテストなどのHTTPクライアント
ruff	Lint / Format

※fastapi[standard] を入れると FastAPI本体に加えて、UvicornやCLI、httpx、python-multipart など標準的に使う依存関係がまとめて入る構成になっています。

// 現時点でのディレクトリ構成
fastapi-learning/
├── .devcontainer/      ← 追加
│   └── Dockerfile     ← 追加
└── requirements.txt

Dockerfileの中身↓

FROM mcr.microsoft.com/devcontainers/python:3.12

WORKDIR /workspace

# Pythonライブラリをインストールする
COPY requirements.txt /tmp/requirements.txt

RUN pip install --no-cache-dir -r /tmp/requirements.txt

// 現時点でのディレクトリ構成
fastapi-learning/
├── .devcontainer/
│   └── Dockerfile
├── compose.yaml     ← 追加
└── requirements.txt

compose.yamlの中身↓

services:
  app:
    build:
      context: .
      dockerfile: .devcontainer/Dockerfile

    volumes:
      - .:/workspace

    command: sleep infinity

    env_file:
      - .env

    depends_on:
      db:
        condition: service_healthy

  db:
    image: postgres:17

    restart: unless-stopped

    environment:
      POSTGRES_DB: ${POSTGRES_DB}
      POSTGRES_USER: ${POSTGRES_USER}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}

    ports:
      - "${POSTGRES_PORT}:5432"

    volumes:
      - postgres_data:/var/lib/postgresql/data

    healthcheck:
      test:
        [
          "CMD-SHELL",
          "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}"
        ]
      interval: 5s
      timeout: 5s
      retries: 10

volumes:
  postgres_data:

これで以下の2サービスをComposeで管理します。

// 現時点でのディレクトリ構成
fastapi-learning/
├── .devcontainer/
│   ├── Dockerfile
│   └── devcontainer.json     ← 追加
├── compose.yaml
└── requirements.txt

devcontainer.jsonの中身↓

{
  "name": "FastAPI Learning",
  "dockerComposeFile": "../compose.yaml",
  "service": "app",
  "workspaceFolder": "/workspace",
  "runServices": [
    "db"
  ],
  "shutdownAction": "stopCompose",
  "remoteUser": "vscode",
  "forwardPorts": [
    8000
  ],

  "customizations": {
    "vscode": {
      "extensions": [
        "ms-python.python",
        "charliermarsh.ruff"
      ]
    }
  }
}

この.devcontainer の設定を読み込むために、VS Codeに「Microsoft製の Dev Containers 拡張機能」をインストールしておきます。これでVS Codeが以下のような流れで開発環境を作ります。

// 現時点でのディレクトリ構成
fastapi-learning/
├── .devcontainer/
│   ├── Dockerfile
│   └── devcontainer.json
├── .env              ← 追加
├── .env.example      ← 追加
├── compose.yaml
└── requirements.txt

まずは.env.exampleを作成します。このファイルは「このプロジェクトでは、こういう環境変数が必要です」ということを他の開発者へ共有するために使います。

POSTGRES_DB=fastapi_learning
POSTGRES_USER=fastapi
POSTGRES_PASSWORD=your_password
POSTGRES_PORT=5432

DATABASE_URL=postgresql+psycopg://fastapi:your_password@db:5432/fastapi_learning

次に.env.exampleをベースに.envを作成します。
※今回はローカル開発用なので単純なパスワードにしています。

POSTGRES_DB=fastapi_learning
POSTGRES_USER=fastapi
POSTGRES_PASSWORD=fastapi
POSTGRES_PORT=5432

DATABASE_URL=postgresql+psycopg://fastapi:fastapi@db:5432/fastapi_learning

// 現時点でのディレクトリ構成
fastapi-learning/
├── .devcontainer/
│   ├── Dockerfile
│   └── devcontainer.json
├── .env
├── .env.example
├── .gitignore      ← 追加
├── compose.yaml
└── requirements.txt

.gitignoreの中身↓

# Environment variables
.env

# Python
__pycache__/
*.py[cod]
*.pyo

# Virtual environment
.venv/
venv/

# pytest
.pytest_cache/
.coverage
htmlcov/

# Ruff
.ruff_cache/

# IDE / OS
.DS_Store
Thumbs.db

Dev Containers: Reopen in Containerを実行すると、

compose.yaml
├─ app
└─ db

が起動して、VS Codeはappコンテナへ接続します。

python -c "import fastapi, sqlalchemy, psycopg, pydantic_settings, pytest; print('OK')"

最初のGET APIを作る

fastapi-learning/
├── .devcontainer/
├── app/
│ └── main.py      ← 追加
├── .env
├── .env.example
├── .gitignore
├── compose.yaml
└── requirements.txt

main.pyの中身↓

from fastapi import FastAPI

# FastAPIアプリケーションを作成する
app = FastAPI()


# GET / にアクセスされたときの処理を定義する
@app.get("/")
def read_root():
    return {"message": "Hello, FastAPI!"}

4行目でFastAPIアプリケーションのインスタンスを作成しています。

app = FastAPI()

Djangoではプロジェクト全体の設定や urls.py などを組み合わせますが、FastAPIではまずこの app オブジェクトがAPIアプリケーションの中心になります。

そして重要なのが8行目です。これは、「HTTPのGETメソッドで / にリクエストが来たら、この下の関数を実行する」という定義です。

@app.get("/")

FastAPIではこのような、

@app.get(...)
@app.post(...)
@app.put(...)
@app.delete(...)

を Path Operation Decorator と呼びます。

今回のコードの場合はGET /のリクエストが来たら、read_root()を実行することになります。
read_root()は普通のPython関数です。

実行するコマンド↓

uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

このコマンドの特に重要なのが、app.main:appの部分です。

これは、「app/main.py にある app というFastAPIアプリケーションを起動する」という意味になります。

app.main：app/main.py というPythonモジュール
:app：main.py内の app = FastAPI() というオブジェクト変数

このコマンドを実行すると以下のように動くイメージです。

uvicorn
└─ app.main:app
      ↓
   app/main.py
      ↓
   app = FastAPI()

--reload は、開発中にソースコードを変更したとき、自動的にサーバーを再起動するためのオプションです。

コマンドの実行結果は次のようになります。

今起きている処理の流れは次ようになります。

ブラウザ
   │
   │ GET /
   ▼
localhost:8000
   │
   ▼
Uvicorn
   │
   ▼
FastAPI
   │
   ▼
@app.get("/")
   │
   ▼
read_root()
   │
   ▼
Pythonのdict
   │
   ▼
JSONレスポンス
   │
   ▼
ブラウザ

※uvicornコマンドで実行したプロセスはCtrl + Cで終了できます。

Swagger UIを確認する

FastAPIでは、Pythonコードに書いた以下の内容からOpenAPI仕様を自動生成し、それをSwagger UIで表示します。

• HTTPメソッド
• URL
• パラメータ
• リクエストデータ
• レスポンス
• 型情報

自力課題

課題内容

完了条件

実装結果

実装したコード：main.py　13行目以降

from fastapi import FastAPI

# FastAPIアプリケーションを作成する
app = FastAPI()


# GET / にアクセスされたときの処理を定義する
@app.get("/")
def read_root():
    return {"message": "Hello, FastAPI!"}


# STEP1 自力課題 GET /hello
@app.get("/hello")
def read_hello():
    return {"message": "Hello from my first API!"}

ブラウザでの表示結果

Swagger UIでの確認結果

ChatGPT先生のレビュー結果

まとめ

STEP1で学んだことを振り返っていきます。

まずFastAPIとは何かを学びました。

FastAPIはWeb API開発用のフレームワークで、HTTP関連の処理やルーティングといったWeb API開発でよく必要となる処理を提供してくれるため、開発者はアプリケーション開発に注力しやすくなります。

DRFではDjangoの上にWeb APIが乗っかるイメージとなるため、APIだけを作りたい場合には構成が大きくなりやすいですが、FastAPIはAPIを中心に必要な機能を組み合わせて構成できるため、扱いやすそうです。

フレームワークの選定基準の一つとして、作りたいものがAPIがメインの場合はFastAPI、Djangoを使ったWebシステムにAPIを追加したい場合はDRF、のような感じで考えることができそうです。（絶対ではありませんが。）

これまでDRFしか使ったことがなく、FastAPIは名前しか知らなかったので、同じWeb API開発用のフレームワークでも用途の違いなどを知ることができてよかったです。

開発環境はcompose.yamlにFastAPIの実装や実行するためのappサービスとdbサービスをそれぞれ作成しました。

FastAPIのライブラリをインストールする際、fastapi[standard]をインストールすることで、FastAPI本体だけでなく、UvicornなどのFastAPI開発でよく使われる依存ライブラリもまとめてインストールすることができるのは便利だと感じました。

今回実装したコードはとても簡単なものでしたが、まずはFastAPIのインスタンスを生成し、そのインスタンスのPath Operation Decoratorを使って、エンドポイントとPython関数との関連付けをしているという基本を理解することできました。

FastAPIは実装内容からAPIドキュメントを自動生成してくれるのはとても便利だと感じました。

DRFを使用していたころはAPIドキュメントを生成するためにdrf-spectacularのライブラリを別途インストールしてAPIドキュメント用のコードを書いていました。仕様変更による修正漏れも多く実装内容とAPIドキュメントが一致していないことが多々あり、とても面倒で手間がかかった記憶があります。

しかし、FastAPIは実装内容からAPIドキュメントを自動生成してくれるため、仕様変更による修正漏れが起きにくそうなのと、APIドキュメントを作るための手間が少ないのはとても魅力的です。

まずは今回学んだ基本をしっかり理解して次回以降のSTEPに取り組んでいきたいと思います。