保護されたAPI呼び出し
発行したアクセストークンを検証する仕組みを実装し、認証済みユーザのみが叩けるGET /notesエンドポイントを作ります。FastAPIのDependsとHTTPBearerスキームを組み合わせて、認証を必要とするエンドポイントに認証依存を注入します。
1. dependencies.py の作成と認証依存の実装
続いて、認証依存を配置するdependencies.pyを作成します。認証依存は複数のハンドラの前段で共通に使う横断的な処理なので、handlers.pyと分けて専用ファイルに置くと役割が明確になります。
Visual Studio Codeのエクスプローラーでjwt-auth-hands-onフォルダを右クリックし、「新しいファイル」を選択してdependencies.pyを作成します。
jwt-auth-hands-on/
├── .env
├── auth.py
├── database.py
├── dependencies.py ← このファイルを作成
├── handlers.py
├── main.py
├── models.py
└── setup_db.py
作成したdependencies.pyに以下の内容を記述して保存します。HTTPBearerスキームと、認証済みユーザを取り出すget_current_user依存関数を定義しています。
from typing import Annotated
from fastapi import Depends, HTTPException
from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
from sqlmodel import Session
from auth import parse_access_token
from database import get_session
from models import User
security = HTTPBearer()
def get_current_user(
credentials: Annotated[HTTPAuthorizationCredentials, Depends(security)],
session: Annotated[Session, Depends(get_session)],
) -> User:
try:
user_id = parse_access_token(credentials.credentials)
except Exception:
raise HTTPException(status_code=401, detail="トークンが無効です")
user = session.get(User, user_id)
if user is None:
raise HTTPException(status_code=401, detail="ユーザが見つかりません")
return user
コードを解説します。
security = HTTPBearer()
HTTPBearerは、Authorization: Bearer <トークン>形式のヘッダを受け取るスキームです。Swagger UI(/docs)に「Authorize」ボタンが表示され、そこから入力したトークンが以降のリクエストに自動で付与されます。
def get_current_user(
credentials: Annotated[HTTPAuthorizationCredentials, Depends(security)],
session: Annotated[Session, Depends(get_session)],
) -> User:
get_current_userの関数シグネチャです。Depends(security)でBearerヘッダから取り出したトークン情報を、Depends(get_session)でDBセッションを注入します。戻り値の型はUserで、保護エンドポイント側はcurrent_user: Userとして直接扱えます。
try:
user_id = parse_access_token(credentials.credentials)
except Exception:
raise HTTPException(status_code=401, detail="トークンが無効です")
credentials.credentialsにトークン本体(Bearer を除いた部分)が入っているので、parse_access_tokenで検証・復号します。検証失敗時は401で早期リターンします。呼び出し元にどの理由で失敗したかは伝えず、抽象化したエラーだけを返します。
user = session.get(User, user_id)
if user is None:
raise HTTPException(status_code=401, detail="ユーザが見つかりません")
return user
user_idをキーにDBからUserを取得します。トークンは有効でもユーザが削除されている場合は401で拒否します。取得したUserインスタンスを返すことで、認証依存を使うハンドラはcurrent_userとして直接ユーザ情報を扱えます。
2. handlers.py への notes ハンドラの追加
handlers.pyのimportにget_current_userを追加し、notesハンドラを末尾に追記します。importを以下のように書き換えます。
from typing import Annotated
from fastapi import APIRouter, Depends, HTTPException, status
from sqlmodel import Session, select
from auth import (
generate_access_token,
generate_refresh_token,
hash_password,
refresh_token_expires_at,
verify_password,
)
from database import get_session
from dependencies import get_current_user
from models import (
LoginRequest,
RefreshToken,
SignupRequest,
TokenResponse,
User,
)
続いて、handlers.pyの末尾(login関数の下)にnotesハンドラを追加します。ここでは認証の動作確認が主眼のため、DBからノートを取得する処理は入れず、current_user.idを含んだ固定のノート一覧を返す形にしています。
@router.get("/notes")
def notes(current_user: Annotated[User, Depends(get_current_user)]):
return [
{"id": 1, "title": "買い物", "user_id": current_user.id},
{"id": 2, "title": "打ち合わせ資料", "user_id": current_user.id},
]
3. コードの解説
@router.get("/notes")
def notes(current_user: Annotated[User, Depends(get_current_user)]):
notesハンドラのシグネチャです。Depends(get_current_user)で認証依存を注入するだけで、そのエンドポイントは自動的に「有効なトークンが必要」な保護エンドポイントになります。ハンドラ側はミドルウェアの登録などを気にせず、current_userを使うだけで済みます。
return [
{"id": 1, "title": "買い物", "user_id": current_user.id},
{"id": 2, "title": "打ち合わせ資料", "user_id": current_user.id},
]
本章では認証の動作確認が主眼のため、DBからノートを取得する処理は入れず、固定のノート一覧を作って返しています。実際のアプリケーションでは、current_user.idをキーにnotesテーブルから該当ユーザのレコードを取得する形になります。
4. 保護されたエンドポイントの動作確認
uvicornは--reloadオプションで動いているので、ファイル保存で自動再起動されます。
まず、Authorizationヘッダを付けずに/notesを叩いて、401が返ることを確認します。
curl -i http://localhost:8000/notes
以下のような実行結果が表示されます。
HTTP/1.1 401 Unauthorized
www-authenticate: Bearer
...
{"detail":"Not authenticated"}
HTTPBearerが働き、Authorizationヘッダの無いリクエストが弾かれています。www-authenticate: Bearer ヘッダは「Bearer 認証で再送してほしい」ことをクライアントに伝える標準的な認証チャレンジで、HTTPBearer が自動で付与します。
次に、先ほど/loginで取得したアクセストークンをAuthorizationヘッダに付けて再度叩きます。トークンの値は自分のログイン結果に置き換えてください。
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." http://localhost:8000/notes
以下のような実行結果が表示されます。
[{"id":1,"title":"買い物","user_id":1},{"id":2,"title":"打ち合わせ資料","user_id":1}]
トークンが検証を通過し、get_current_userで取得されたUserのIDを使ってノート一覧が返されています。認証済みユーザのみが叩けるエンドポイントの雛形ができました。
| ⚠️ トークンが「トークンが無効です」で弾かれる場合 |
|---|
Authorization: Bearer 〜のスペース位置と、トークン文字列を最後まで正しくコピーできているかを確認してください。改行や末尾の空白が入っていると、parse_access_token側で署名検証に失敗します。また、アクセストークンの有効期限は15分に設定しているため、時間が経ちすぎている場合は再度/loginを叩いて発行し直します。 |