# FastAPI と PostgreSQL で JWT 認証付きユーザー API を構築する方法

## 目次

1. はじめに
2. プロジェクトのセットアップ
   - 2.1 必要なパッケージのインストール
   - 2.2 ディレクトリ構造
3. データベースの構成
   - 3.1 PostgreSQL データベースの準備
   - 3.2 データベースモデルの定義
4. ユーザー認証の実装
   - 4.1 JWT の設定
   - 4.2 ユーザー登録エンドポイントの作成
   - 4.3 ログインエンドポイントの作成
5. API エンドポイント
   - 5.1 ユーザー情報の取得
   - 5.2 ユーザー情報の更新
6. セキュリティ対策
   - 6.1 パスワードのハッシュ化
   - 6.2 トークン認証の強化
7. テストとデプロイメント
   - 7.1 テストの実施
   - 7.2 デプロイメント方法
8. まとめ

## 1. はじめに

FastAPI は、Python の非同期 Web フレームワークであり、高速な開発スピードとパフォーマンスを特徴としています。この記事では、FastAPI と PostgreSQL を使用して、JWT 認証を備えたユーザー管理 API を構築する方法を説明します。JWT (JSON Web Token) は、クライアントとサーバー間の認証をセキュアに行うためによく使用されます。

## 2. プロジェクトのセットアップ

FastAPI プロジェクトをセットアップするために、必要なパッケージをインストールし、ディレクトリ構造を整理します。

### 2.1 必要なパッケージのインストール

以下のパッケージをインストールします。

![img](/mosaic-code.jpg)

- `fastapi[all]`: FastAPI フレームワークとそのすべての依存関係
- `psycopg2-binary`: PostgreSQL データベースクライアント
- `tortoise-orm`: ORM (オブジェクト関係マッピング) ライブラリ
- `python-jose`: JWT のエンコードとデコードに使用
- `passlib[bcrypt]`: パスワードハッシュ化用

### 2.2 ディレクトリ構造

プロジェクトのディレクトリは以下のようになります。

![img](/mosaic-code.jpg)

## 3. データベースの構成

PostgreSQL を使用して、ユーザーデータを保持します。

### 3.1 PostgreSQL データベースの準備

まず、PostgreSQL に接続して以下のコマンドを実行し、データベースを作成します。

![img](/mosaic-code.jpg)

### 3.2 データベースモデルの定義

データベースモデルを `models.py` で定義します。

![img](/mosaic-code.jpg)

上記では、ユーザーの ID、ユーザー名、およびハッシュ化されたパスワードを保存するためのテーブルを定義しています。

## 4. ユーザー認証の実装

FastAPI で JWT 認証を実装します。

### 4.1 JWT の設定

JWT を使用するための設定と関数を `auth.py` に記述します。

![img](/mosaic-code.jpg)

### 4.2 ユーザー登録エンドポイントの作成

新規ユーザーを作成するエンドポイントを `routes.py` に追加します。

![img](/mosaic-code.jpg)

### 4.3 ログインエンドポイントの作成

ユーザーに JWT を発行するためのログインエンドポイントも追加します。

![img](/mosaic-code.jpg)

## 5. API エンドポイント

ユーザー情報を取得および更新するためのエンドポイントを実装します。

### 5.1 ユーザー情報の取得

ユーザー情報を取得するためのエンドポイントを追加します。

![img](/mosaic-code.jpg)

### 5.2 ユーザー情報の更新

ユーザー情報を更新するためのエンドポイントも提供します。

![img](/mosaic-code.jpg)

## 6. セキュリティ対策

セキュアなアプリケーションを維持するために、パスワードのハッシュ化などのセキュリティ対策を講じます。

### 6.1 パスワードのハッシュ化

ユーザーのパスワードを保存する前に、必ず安全なハッシュ化を行ってください。この記事の実装では、bcrypt を使用しています。

### 6.2 トークン認証の強化

JWT を使用してユーザーを認証する場合、秘密鍵の管理に細心の注意を払い、トークンの有効期限を設定して、盗難された場合の悪用を防ぐ必要があります。

## 7. テストとデプロイメント

最終ステップでは、アプリのテストとデプロイメントについて説明します。

### 7.1 テストの実施

FastAPI の組み込みのドキュメント生成機能を使用して、Swagger UI で API のテストを実施できます。

### 7.2 デプロイメント方法

UVicorn を使用して FastAPI アプリをデプロイすることがよく行われます。

![img](/mosaic-code.jpg)

Docker などのコンテナを使用してデプロイすることも可能です。

## 8. まとめ

FastAPI と PostgreSQL を使用してJWT 認証付きのユーザー API を構築しました。この記事では、ユーザー登録、ログイン、ユーザー情報の取得と更新の各プロセスを実装しました。FastAPI を使用することで、迅速に、高性能な API を開発できることがわかります。次回は、さらなるセキュリティとスケーラビリティの向上を目指します。 [cv:issue_marketplace_engineer]

# FastAPI と PostgreSQL で JWT 認証付きユーザー API を構築する方法

## 目次

1. はじめに
2. プロジェクトのセットアップ
   - 2.1 必要なパッケージのインストール
   - 2.2 ディレクトリ構造
3. データベースの構成
   - 3.1 PostgreSQL データベースの準備
   - 3.2 データベースモデルの定義
4. ユーザー認証の実装
   - 4.1 JWT の設定
   - 4.2 ユーザー登録エンドポイントの作成
   - 4.3 ログインエンドポイントの作成
5. API エンドポイント
   - 5.1 ユーザー情報の取得
   - 5.2 ユーザー情報の更新
6. セキュリティ対策
   - 6.1 パスワードのハッシュ化
   - 6.2 トークン認証の強化
7. テストとデプロイメント
   - 7.1 テストの実施
   - 7.2 デプロイメント方法
8. まとめ

## 1. はじめに

FastAPI は、Python の非同期 Web フレームワークであり、高速な開発スピードとパフォーマンスを特徴としています。この記事では、FastAPI と PostgreSQL を使用して、JWT 認証を備えたユーザー管理 API を構築する方法を説明します。JWT (JSON Web Token) は、クライアントとサーバー間の認証をセキュアに行うためによく使用されます。

## 2. プロジェクトのセットアップ

FastAPI プロジェクトをセットアップするために、必要なパッケージをインストールし、ディレクトリ構造を整理します。

### 2.1 必要なパッケージのインストール

以下のパッケージをインストールします。

```bash
pip install fastapi[all] psycopg2-binary tortoise-orm python-jose passlib[bcrypt]
```

- `fastapi[all]`: FastAPI フレームワークとそのすべての依存関係
- `psycopg2-binary`: PostgreSQL データベースクライアント
- `tortoise-orm`: ORM (オブジェクト関係マッピング) ライブラリ
- `python-jose`: JWT のエンコードとデコードに使用
- `passlib[bcrypt]`: パスワードハッシュ化用

### 2.2 ディレクトリ構造

プロジェクトのディレクトリは以下のようになります。

```
project-root
├── app
│   ├── main.py        # エントリーポイント
│   ├── models.py      # データベースモデル
│   ├── auth.py        # 認証ロジック
│   └── routes.py      # API ルート
└── requirements.txt  # パッケージリスト
```

## 3. データベースの構成

PostgreSQL を使用して、ユーザーデータを保持します。

### 3.1 PostgreSQL データベースの準備

まず、PostgreSQL に接続して以下のコマンドを実行し、データベースを作成します。

```sql
CREATE DATABASE user_api;
```

### 3.2 データベースモデルの定義

データベースモデルを `models.py` で定義します。

```python
from tortoise import fields, models
from tortoise.contrib.pydantic import pydantic_model_creator

class User(models.Model):
    id = fields.IntField(pk=True)
    username = fields.CharField(max_length=20, unique=True)
    hashed_password = fields.CharField(max_length=128)

User_Pydantic = pydantic_model_creator(User, name="User")
```

上記では、ユーザーの ID、ユーザー名、およびハッシュ化されたパスワードを保存するためのテーブルを定義しています。

## 4. ユーザー認証の実装

FastAPI で JWT 認証を実装します。

### 4.1 JWT の設定

JWT を使用するための設定と関数を `auth.py` に記述します。

```python
from datetime import datetime, timedelta
from jose import JWTError, jwt
from passlib.context import CryptContext

SECRET_KEY = "your-secret-key"
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 30

pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")

def create_access_token(data: dict):
    to_encode = data.copy()
    expire = datetime.utcnow() + timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
    to_encode.update({"exp": expire})
    return jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)

def verify_password(plain_password, hashed_password):
    return pwd_context.verify(plain_password, hashed_password)

def get_password_hash(password):
    return pwd_context.hash(password)
```

### 4.2 ユーザー登録エンドポイントの作成

新規ユーザーを作成するエンドポイントを `routes.py` に追加します。

```python
from fastapi import APIRouter, Depends
from app.models import User, User_Pydantic
from app.auth import get_password_hash
from tortoise.contrib.fastapi import HTTPNotFoundError, register_tortoise

router = APIRouter()

@router.post("/register", response_model=User_Pydantic)
async def register_user(username: str, password: str):
    user = User(username=username, hashed_password=get_password_hash(password))
    await user.save()
    return await User_Pydantic.from_tortoise_orm(user)
```

### 4.3 ログインエンドポイントの作成

ユーザーに JWT を発行するためのログインエンドポイントも追加します。

```python
from fastapi import HTTPException

@router.post("/token")
async def login(username: str, password: str):
    user = await User.get(username=username)
    if not user or not verify_password(password, user.hashed_password):
        raise HTTPException(status_code=400, detail="Invalid credentials")
    access_token = create_access_token(data={"sub": user.username})
    return {"access_token": access_token, "token_type": "bearer"}
```

## 5. API エンドポイント

ユーザー情報を取得および更新するためのエンドポイントを実装します。

### 5.1 ユーザー情報の取得

ユーザー情報を取得するためのエンドポイントを追加します。

```python
@router.get("/users/me", response_model=User_Pydantic)
async def read_users_me():
    user = await User.get(username="some_username")  # JWTでusernameを抽出して置き換える
    return await User_Pydantic.from_tortoise_orm(user)
```

### 5.2 ユーザー情報の更新

ユーザー情報を更新するためのエンドポイントも提供します。

```python
@router.put("/users/me", response_model=User_Pydantic)
async def update_user_data(username: str, password: str):
    user = await User.get(username="some_username")  # JWTでusernameを抽出して置き換える
    user.hashed_password = get_password_hash(password)
    await user.save()
    return await User_Pydantic.from_tortoise_orm(user)
```

## 6. セキュリティ対策

セキュアなアプリケーションを維持するために、パスワードのハッシュ化などのセキュリティ対策を講じます。

### 6.1 パスワードのハッシュ化

ユーザーのパスワードを保存する前に、必ず安全なハッシュ化を行ってください。この記事の実装では、bcrypt を使用しています。

### 6.2 トークン認証の強化

JWT を使用してユーザーを認証する場合、秘密鍵の管理に細心の注意を払い、トークンの有効期限を設定して、盗難された場合の悪用を防ぐ必要があります。

## 7. テストとデプロイメント

最終ステップでは、アプリのテストとデプロイメントについて説明します。

### 7.1 テストの実施

FastAPI の組み込みのドキュメント生成機能を使用して、Swagger UI で API のテストを実施できます。

### 7.2 デプロイメント方法

UVicorn を使用して FastAPI アプリをデプロイすることがよく行われます。

```bash
uvicorn app.main:app --host 0.0.0.0 --port 8000
```

Docker などのコンテナを使用してデプロイすることも可能です。

## 8. まとめ

FastAPI と PostgreSQL を使用してJWT 認証付きのユーザー API を構築しました。この記事では、ユーザー登録、ログイン、ユーザー情報の取得と更新の各プロセスを実装しました。FastAPI を使用することで、迅速に、高性能な API を開発できることがわかります。次回は、さらなるセキュリティとスケーラビリティの向上を目指します。 [![image](https://firebasestorage.googleapis.com/v0/b/issue-pro-42602.appspot.com/o/topics%2F17fa658b-53c7-4ca0-a28b-e588ed1bd371?alt=media&token=2c00afff-85ff-4428-8d15-696ab676dcb0)](https://i-ssue.com/lp/check_salary)

FastAPI と PostgreSQL で JWT 認証付きユーザー API を構築する方法

目次

続きを読むには単価診断を受けてください（30秒）