# FastAPIとPostgreSQLで特定ユーザーの変更履歴を取得するAPIの作成

## 目次
1. はじめに
2. 開発環境のセットアップ
   - 2.1 必要なライブラリのインストール
   - 2.2 PostgreSQLデータベースの設定
3. データベーススキーマの設計
   - 3.1 ユーザーテーブルの設計
   - 3.2 変更履歴テーブルの設計
4. FastAPIプロジェクトの構築
   - 4.1 プロジェクトの基本設定
   - 4.2 モデルの定義
   - 4.3 エンドポイントの実装
5. 特定ユーザーの変更履歴を取得するエンドポイント
   - 5.1 エンドポイントの設計
   - 5.2 SQLAlchemy ORMを使ったデータ取得
6. 認証と認可の実装
   - 6.1 ユーザー認証のしくみ
   - 6.2 認可の実装
7. テストとデプロイ
   - 7.1 ユニットテストの作成
   - 7.2 Herokuを使ったデプロイ
8. まとめ

## 1. はじめに
本記事では、FastAPIとPostgreSQLを使用して、特定ユーザーの変更履歴を取得するAPIを構築します。FastAPIは、Python製の最新のWebフレームワークで、非同期処理が容易であり、データベースとの統合もスムーズです。PostgreSQLは、安定性と拡張性を兼ね備えたリレーショナルデータベースシステムで、多くの業務システムで採用されています。

## 2. 開発環境のセットアップ

### 2.1 必要なライブラリのインストール
始めに、Python仮想環境を設定し、FastAPI、SQLAlchemy、およびPostgreSQLドライバである`asyncpg`をインストールします。

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

### 2.2 PostgreSQLデータベースの設定
PostgreSQLがインストールされていることを確認し、開発用データベースを作成します。

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

必要に応じて、ユーザーやパスワードの設定も行ってください。

## 3. データベーススキーマの設計

### 3.1 ユーザーテーブルの設計
ユーザーテーブルは、基本的な情報を保持します。

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

### 3.2 変更履歴テーブルの設計
ユーザーの変更履歴を記録するために、履歴テーブルを作成します。

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

## 4. FastAPIプロジェクトの構築

### 4.1 プロジェクトの基本設定
FastAPIプロジェクトを開始するディレクトリを作成し、メインアプリケーションファイルを用意します。

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

### 4.2 モデルの定義
SQLAlchemyを使用して、データベースのエンティティを定義します。

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

### 4.3 エンドポイントの実装
FastAPIで基本的なCRUD操作を実装します。

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

## 5. 特定ユーザーの変更履歴を取得するエンドポイント

### 5.1 エンドポイントの設計
特定のユーザーの全変更履歴を返すエンドポイントを設計し、ユーザーIDをパスパラメータで受け取ります。

### 5.2 SQLAlchemy ORMを使ったデータ取得
ユーザーIDを基に`UserActivityLog`テーブルを照会し、変更履歴のデータを取得します。

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

## 6. 認証と認可の実装

### 6.1 ユーザー認証のしくみ
JWTを使用してユーザーを認証し、トークンベースの認証を実装します。

### 6.2 認可の実装
取得するデータが要求するAPIエンドポイントに対し、ユーザー固有の認可を確認します。

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

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

### 7.1 ユニットテストの作成
`pytest`を使用してAPIエンドポイントのユニットテストを作成します。

### 7.2 Herokuを使ったデプロイ
プロジェクトをHeroku上でデプロイし、実際の運用環境での動作を確認します。

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

## 8. まとめ
今回はFastAPIとPostgreSQLを使用して、特定ユーザーの変更履歴を取得するAPIを構築しました。FastAPIの柔軟さとPostgreSQLの信頼性を活用することで、効率的にデータを管理できます。これを基に、更なる拡張や機能追加をしていくことが可能です。 [cv:issue_marketplace_engineer]

# FastAPIとPostgreSQLで特定ユーザーの変更履歴を取得するAPIの作成

## 目次
1. はじめに
2. 開発環境のセットアップ
   - 2.1 必要なライブラリのインストール
   - 2.2 PostgreSQLデータベースの設定
3. データベーススキーマの設計
   - 3.1 ユーザーテーブルの設計
   - 3.2 変更履歴テーブルの設計
4. FastAPIプロジェクトの構築
   - 4.1 プロジェクトの基本設定
   - 4.2 モデルの定義
   - 4.3 エンドポイントの実装
5. 特定ユーザーの変更履歴を取得するエンドポイント
   - 5.1 エンドポイントの設計
   - 5.2 SQLAlchemy ORMを使ったデータ取得
6. 認証と認可の実装
   - 6.1 ユーザー認証のしくみ
   - 6.2 認可の実装
7. テストとデプロイ
   - 7.1 ユニットテストの作成
   - 7.2 Herokuを使ったデプロイ
8. まとめ

## 1. はじめに
本記事では、FastAPIとPostgreSQLを使用して、特定ユーザーの変更履歴を取得するAPIを構築します。FastAPIは、Python製の最新のWebフレームワークで、非同期処理が容易であり、データベースとの統合もスムーズです。PostgreSQLは、安定性と拡張性を兼ね備えたリレーショナルデータベースシステムで、多くの業務システムで採用されています。

## 2. 開発環境のセットアップ

### 2.1 必要なライブラリのインストール
始めに、Python仮想環境を設定し、FastAPI、SQLAlchemy、およびPostgreSQLドライバである`asyncpg`をインストールします。

```bash
python3 -m venv venv
source venv/bin/activate
pip install fastapi uvicorn sqlalchemy asyncpg
```

### 2.2 PostgreSQLデータベースの設定
PostgreSQLがインストールされていることを確認し、開発用データベースを作成します。

```sql
CREATE DATABASE user_activity;
```

必要に応じて、ユーザーやパスワードの設定も行ってください。

## 3. データベーススキーマの設計

### 3.1 ユーザーテーブルの設計
ユーザーテーブルは、基本的な情報を保持します。

```sql
CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    username VARCHAR(50) NOT NULL,
    email VARCHAR(100) UNIQUE NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
```

### 3.2 変更履歴テーブルの設計
ユーザーの変更履歴を記録するために、履歴テーブルを作成します。

```sql
CREATE TABLE user_activity_logs (
    id SERIAL PRIMARY KEY,
    user_id INTEGER REFERENCES users(id) ON DELETE CASCADE,
    field_changed VARCHAR(50) NOT NULL,
    old_value TEXT,
    new_value TEXT,
    change_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
```

## 4. FastAPIプロジェクトの構築

### 4.1 プロジェクトの基本設定
FastAPIプロジェクトを開始するディレクトリを作成し、メインアプリケーションファイルを用意します。

```bash
mkdir fastapi_user_activity
cd fastapi_user_activity
touch main.py
```

### 4.2 モデルの定義
SQLAlchemyを使用して、データベースのエンティティを定義します。

```python
# models.py
from sqlalchemy import Column, Integer, String, ForeignKey, DateTime
from sqlalchemy.orm import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'
    
    id = Column(Integer, primary_key=True, index=True)
    username = Column(String, unique=True, index=True, nullable=False)
    email = Column(String, unique=True, index=True, nullable=False)
    created_at = Column(DateTime)

class UserActivityLog(Base):
    __tablename__ = 'user_activity_logs'
    
    id = Column(Integer, primary_key=True, index=True)
    user_id = Column(Integer, ForeignKey('users.id', ondelete='CASCADE'))
    field_changed = Column(String, nullable=False)
    old_value = Column(String)
    new_value = Column(String)
    change_date = Column(DateTime)
```

### 4.3 エンドポイントの実装
FastAPIで基本的なCRUD操作を実装します。

```python
# main.py
from fastapi import FastAPI, HTTPException
from sqlalchemy.future import select
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
from sqlalchemy.orm import sessionmaker
from models import User, UserActivityLog

DATABASE_URL = "postgresql+asyncpg://user:password@localhost/user_activity"

engine = create_async_engine(DATABASE_URL, echo=True)
SessionLocal = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)

app = FastAPI()

@app.get("/users/{user_id}/activity")
async def get_user_activity(user_id: int):
    async with SessionLocal() as session:
        result = await session.execute(
            select(UserActivityLog).where(UserActivityLog.user_id == user_id)
        )
        logs = result.scalars().all()
    if not logs:
        raise HTTPException(status_code=404, detail="User activity logs not found")
    return logs
```

## 5. 特定ユーザーの変更履歴を取得するエンドポイント

### 5.1 エンドポイントの設計
特定のユーザーの全変更履歴を返すエンドポイントを設計し、ユーザーIDをパスパラメータで受け取ります。

### 5.2 SQLAlchemy ORMを使ったデータ取得
ユーザーIDを基に`UserActivityLog`テーブルを照会し、変更履歴のデータを取得します。

```python
# main.py 部分
@app.get("/users/{user_id}/activity")
async def get_user_activity(user_id: int):
    async with SessionLocal() as session:
        result = await session.execute(
            select(UserActivityLog).where(UserActivityLog.user_id == user_id)
        )
        logs = result.scalars().all()
    if not logs:
        raise HTTPException(status_code=404, detail="User activity logs not found")
    return logs
```

## 6. 認証と認可の実装

### 6.1 ユーザー認証のしくみ
JWTを使用してユーザーを認証し、トークンベースの認証を実装します。

### 6.2 認可の実装
取得するデータが要求するAPIエンドポイントに対し、ユーザー固有の認可を確認します。

```python
# auth.py
from fastapi import Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

async def get_current_user(token: str = Depends(oauth2_scheme)):
    # トークンの検証とユーザーIDの抽出
    user_id = decode_jwt_token(token)
    if not user_id:
        raise HTTPException(
            status_code=401, detail="Invalid authentication credentials"
        )
    return user_id
```

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

### 7.1 ユニットテストの作成
`pytest`を使用してAPIエンドポイントのユニットテストを作成します。

### 7.2 Herokuを使ったデプロイ
プロジェクトをHeroku上でデプロイし、実際の運用環境での動作を確認します。

```bash
# Procfile
web: uvicorn main:app --host 0.0.0.0 --port ${PORT:-5000}
```

## 8. まとめ
今回はFastAPIとPostgreSQLを使用して、特定ユーザーの変更履歴を取得するAPIを構築しました。FastAPIの柔軟さとPostgreSQLの信頼性を活用することで、効率的にデータを管理できます。これを基に、更なる拡張や機能追加をしていくことが可能です。 

FastAPIとPostgreSQLで特定ユーザーの変更履歴を取得するAPIの作成

目次

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