
# FastAPIとPostgreSQLを使ったCRUD APIの実装方法（SQLAlchemy編）

## 1-1. 目次
1. はじめに
2. 環境設定
    1. 必要なパッケージのインストール
    2. データベースの設定
3. SQLAlchemyの設定
    1. モデルの作成
    2. データベースセッションの設定
4. FastAPIのセットアップ
    1. アプリケーションの初期化
    2. エンドポイントの作成
5. CRUD操作の実装
    1. CREATE操作
    2. READ操作
    3. UPDATE操作
    4. DELETE操作
6. 完成したAPIをテストする
7. まとめ
8. [cv:issue_marketplace_engineer]

## 1-2. はじめに
本記事では、PythonのWebフレームワークであるFastAPIを使用し、PostgreSQLをデータベースとするCRUD APIを実装します。データアクセスライブラリにはSQLAlchemyを用います。FastAPIは非同期処理が可能であり、型ヒントを活用した簡潔なコードが特徴です。この記事を通して、CRUD操作を効率的に実装する方法を学びます。

## 2-1. 環境設定

### 2-1-1. 必要なパッケージのインストール
![img](/mosaic-code.jpg)
これにより、FastAPI、UVicorn、SQLAlchemy、およびPostgreSQLに接続するための必要なパッケージがインストールされます。

### 2-1-2. データベースの設定
まず、PostgreSQLデータベースを作成します。以下はpostgresユーザーでデータベースを作成するコマンドです。
![img](/mosaic-code.jpg)

## 3-1. SQLAlchemyの設定

### 3-1-1. モデルの作成
SQLAlchemyのモデルはPythonのクラスとして定義します。以下にUserモデルを作成します。
![img](/mosaic-code.jpg)

### 3-1-2. データベースセッションの設定
![img](/mosaic-code.jpg)

## 4-1. FastAPIのセットアップ

### 4-1-1. アプリケーションの初期化
![img](/mosaic-code.jpg)

### 4-1-2. エンドポイントの作成
この段階で、ルートやエンドポイントを定義し始めますが、CRUD操作の具体的な実装は次章で行います。

## 5-1. CRUD操作の実装

### 5-1-1. CREATE操作
![img](/mosaic-code.jpg)

### 5-1-2. READ操作
![img](/mosaic-code.jpg)

### 5-1-3. UPDATE操作
![img](/mosaic-code.jpg)

### 5-1-4. DELETE操作
![img](/mosaic-code.jpg)

## 6-1. 完成したAPIをテストする
次に、完成したAPIをテストして動作を確認します。以下のコマンドでサーバーを起動し、機能を確認してください。
![img](/mosaic-code.jpg)

## 7-1. まとめ
本記事ではFastAPIを使用してPostgreSQLと連携したCRUD APIを構築しました。FastAPIの速さと型ヒントの効率性、SQLAlchemyによるデータベース操作の柔軟性を組み合わせることで、迅速かつ信頼性のあるバックエンドシステムを構築する方法を学びました。今後は、認証の追加や、非同期処理を駆使してさらに高速なAPIを構築することを検討してみてください。 [cv:issue_marketplace_engineer]


# FastAPIとPostgreSQLを使ったCRUD APIの実装方法（SQLAlchemy編）

## 1-1. 目次
1. はじめに
2. 環境設定
    1. 必要なパッケージのインストール
    2. データベースの設定
3. SQLAlchemyの設定
    1. モデルの作成
    2. データベースセッションの設定
4. FastAPIのセットアップ
    1. アプリケーションの初期化
    2. エンドポイントの作成
5. CRUD操作の実装
    1. CREATE操作
    2. READ操作
    3. UPDATE操作
    4. DELETE操作
6. 完成したAPIをテストする
7. まとめ
8. [![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)

## 1-2. はじめに
本記事では、PythonのWebフレームワークであるFastAPIを使用し、PostgreSQLをデータベースとするCRUD APIを実装します。データアクセスライブラリにはSQLAlchemyを用います。FastAPIは非同期処理が可能であり、型ヒントを活用した簡潔なコードが特徴です。この記事を通して、CRUD操作を効率的に実装する方法を学びます。

## 2-1. 環境設定

### 2-1-1. 必要なパッケージのインストール
```bash
pip install fastapi
pip install uvicorn[standard]
pip install sqlalchemy
pip install psycopg2-binary
```
これにより、FastAPI、UVicorn、SQLAlchemy、およびPostgreSQLに接続するための必要なパッケージがインストールされます。

### 2-1-2. データベースの設定
まず、PostgreSQLデータベースを作成します。以下はpostgresユーザーでデータベースを作成するコマンドです。
```bash
psql -U postgres -c "CREATE DATABASE mydatabase;"
```

## 3-1. SQLAlchemyの設定

### 3-1-1. モデルの作成
SQLAlchemyのモデルはPythonのクラスとして定義します。以下にUserモデルを作成します。
```python
from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String, index=True)
    email = Column(String, unique=True, index=True)
```

### 3-1-2. データベースセッションの設定
```python
from sqlalchemy.orm import sessionmaker

DATABASE_URL = "postgresql://postgres:password@localhost/mydatabase"

engine = create_engine(DATABASE_URL)
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
```

## 4-1. FastAPIのセットアップ

### 4-1-1. アプリケーションの初期化
```python
from fastapi import FastAPI

app = FastAPI()
```

### 4-1-2. エンドポイントの作成
この段階で、ルートやエンドポイントを定義し始めますが、CRUD操作の具体的な実装は次章で行います。

## 5-1. CRUD操作の実装

### 5-1-1. CREATE操作
```python
from fastapi import HTTPException, Depends, Body
from sqlalchemy.orm import Session

from .models import User, Base
from .database import engine, SessionLocal

Base.metadata.create_all(bind=engine)

def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

@app.post("/users/", response_model=UserSchema)
def create_user(user: UserCreate, db: Session = Depends(get_db)):
    db_user = User(name=user.name, email=user.email)
    db.add(db_user)
    db.commit()
    db.refresh(db_user)
    return db_user
```

### 5-1-2. READ操作
```python
@app.get("/users/{user_id}", response_model=UserSchema)
def read_user(user_id: int, db: Session = Depends(get_db)):
    db_user = db.query(User).filter(User.id == user_id).first()
    if db_user is None:
        raise HTTPException(status_code=404, detail="User not found")
    return db_user
```

### 5-1-3. UPDATE操作
```python
@app.put("/users/{user_id}", response_model=UserSchema)
def update_user(user_id: int, user: UserUpdate, db: Session = Depends(get_db)):
    db_user = db.query(User).filter(User.id == user_id).first()
    if db_user is None:
        raise HTTPException(status_code=404, detail="User not found")
    db_user.name = user.name
    db_user.email = user.email
    db.commit()
    db.refresh(db_user)
    return db_user
```

### 5-1-4. DELETE操作
```python
@app.delete("/users/{user_id}", response_model=UserSchema)
def delete_user(user_id: int, db: Session = Depends(get_db)):
    db_user = db.query(User).filter(User.id == user_id).first()
    if db_user is None:
        raise HTTPException(status_code=404, detail="User not found")
    db.delete(db_user)
    db.commit()
    return db_user
```

## 6-1. 完成したAPIをテストする
次に、完成したAPIをテストして動作を確認します。以下のコマンドでサーバーを起動し、機能を確認してください。
```bash
uvicorn main:app --reload
```

## 7-1. まとめ
本記事ではFastAPIを使用してPostgreSQLと連携したCRUD APIを構築しました。FastAPIの速さと型ヒントの効率性、SQLAlchemyによるデータベース操作の柔軟性を組み合わせることで、迅速かつ信頼性のあるバックエンドシステムを構築する方法を学びました。今後は、認証の追加や、非同期処理を駆使してさらに高速な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を使ったCRUD APIの実装方法（SQLAlchemy編）

1-1. 目次

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