FastAPI＋PostgreSQLでデータ追加。INSERT文を実行する方法
本記事はPython初学者やFastAPIを学習したいと考えているWebエンジニア向けの入門者向けの記事になります。
この記事はFastAPIとPostgreSQLでデータ追加（INSERT）するAPIを作成したいと思います。
ファイル構成とディレクトリ構成の確認
FastAPIのプロジェクトディレクトリの構成は以下になります。
fastapi/
├ venv/
└ src/
├ alembic
│ ├ env.py
│ ├ README
│ ├ script.py.mako
│ └ versions/
│ └ 1f3b2391d90c_create_users_table.py
├ alembic.ini
├ crud.py
├ database.py
├ main.py
├ models.py
└ schemas.py今回の記事で修正するファイルは以下になります。
- src/schemas.py
- src/crud.py
- src/main.py
まずはsrc/schemas.py を修正します。UserCreateを追記してください。
from pydantic import BaseModel
class UserBase(BaseModel):
name: str
age: int
email: str
class Config:
orm_mode = True
class UserPublic(UserBase):
user_id: int
name: str
age: int
email: str
# 以下を追記
class UserCreate(UserBase):
user_id: int
name: str
age: int
email: str次にsrc/crud.pyを修正します。create_user関数を追記してください。
from sqlalchemy.orm import Session
import models
import schemas
def get_user(db: Session, user_id: int):
return db.query(models.User).filter(models.User.user_id == user_id).first()
def get_all_user(db: Session):
return db.query(models.User).all()
def create_user(db: Session, user: schemas.UserCreate):
user_obj = models.User(
name=user.name,
age=user.age,
email=user.email,
)
db.add(user)
db.commit()
db.refresh(user)
return user_obj最後にsrc/main.pyを修正します。create_user関数を追記します。
from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import List
from database import engine, get_db
import models
import schemas
import crud
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
@app.get("/user/{user_id}", response_model=schemas.UserPublic)
def get_user(user_id: int, db: Session = Depends(get_db)):
db_user = crud.get_user(db=db, user_id=user_id)
if db_user is None:
raise HTTPException(status_code=404, detail="User not found")
return db_user
@app.get("/user/", response_model=List[schemas.UserPublic])
def get_all_user(db: Session = Depends(get_db)):
db_users = crud.get_all_user(db=db)
if db_users is None:
raise HTTPException(status_code=404, detail="User not found")
return db_users
@app.post("/user/create")
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)):
db_user = crud.create_user(db=db, user=user)
return userこれで修正は完了です。
FastAPIからデータを追加してみる
では実際にFastAPIからデータを追加していきたいと思います。まずはFastAPIを起動します。
uvicorn main:app --reload --reload --workers 1 --host 0.0.0.0 --port 8000今回はGoogle ChromeのAdvanced rest clientという拡張プラグインを使用します。
Method、Request URLを以下の様に編集してください。
urlのhttp://IPアドレス:8000/user/create としてみましょう。
次にBodyを以下の様に編集します。
{
"name": "test004",
"age": 20,
"email": "test004@sample.com",
"user_id": 4
}そして最後にsendボタンをクリックします。
以下のようにレスポンスされればINSERTは完了です。
{
"name": "test004",
"age": 20,
"email": "test004@sample.com",
"user_id": 4
}では実際にデータ追加されたか確認してみます。
postgreユーザにスイッチして、usersテーブルに確認してみましょう。
su - postgres
psql -U fastapi -h 127.0.0.1 -p 5432 fastapiデータが挿入されていることを確認しましょう。
fastapi=> select * from users;
user_id | name | age | email
---------+---------+-----+--------------------
1 | test001 | 20 | test001@sample.com
2 | test002 | 30 | test002@sample.com
3 | test003 | 30 | test003@sample.com
4 | test004 | 20 | test004@sample.comこれでデータ追加（INSERT文）が正常に行われたことが確認できました。