fastAPI 로 백엔드 시작하기 (환경 세팅, 폴더 구조, mysql 사용)

flask를 써봤다면 조금 익숙할 수도 있다. 

 

예시 참고

https://github.com/tiangolo/full-stack-fastapi-template

GitHub - tiangolo/full-stack-fastapi-template: Full stack, modern web application template. Using FastAPI, React, SQLModel, Post

 

나의 경우에는 다음과 같이 짰다.

.
├── app
│   ├── __init__.py
│   ├── main.py
│   ├── database.py
│   ├── models.py
│   ├── schemas.py
│   ├── crud.py
│   └── routers  -(각종 라우터들)
│       ├── __init__.py
│       ├── japanese.py
│       └── known.py
├── tests
│   ├── __init__.py
│   ├── test_database.py
│   └── test_main.py
├── requirements.txt
├── .env
└── README.md

 

---

• requirements.txt

일단 가상환경을 생성한 후, 필요한 패키지들을 설치한다. 

이들은 requirements.txt로 관리한다

fastapi
uvicorn
sqlalchemy
mysqlclient
python-dotenv
pydantic

- FastAPI와 함께 MySQL을 사용하려면, mysqlclient나 aiomysql 같은 MySQL 데이터베이스 드라이버가 필요합니다. python-dotenv는 환경 변수를 관리하기 위해 사용합니다. SQLAlchemy는 ORM을 제공합니다.

 

• .env

데이터베이스 연결에 필요한 정보를 저장

DATABASE_URL=mysql://user:password@localhost/dbname

 

주요 구성 요소 설명

• "app" 폴더는 모든 소스 코드를 포함합니다.
• app/main.py: FastAPI 앱 인스턴스를 생성하고 라우터를 포함하는 파일입니다. 이 파일에서 앱 설정을 진행합니다.
• app/database.py: 데이터베이스 연결과 세션 관리를 위한 설정을 포함합니다. SQLAlchemy를 사용하는 예시입니다.
• app/models.py: 데이터베이스 테이블을 SQLAlchemy 모델로 정의합니다. 이 예시에서는 japanese 및 known 테이블에 해당하는 모델을 정의합니다.
• app/schemas.py: 클라이언트와의 데이터 교환에 사용되는 Pydantic 모델(스키마)을 정의합니다. 요청 및 응답 스키마를 정의하는 곳입니다.
• app/crud.py: 데이터베이스의 CRUD 연산을 수행하는 함수들을 정의합니다. 이 함수들은 일반적으로 모델과 스키마를 사용하여 데이터베이스와의 상호작용을 캡슐화합니다.
• app/routers/: 각 기능별로 경로 연산을 나누어 관리하기 위한 라우터 파일들을 포함하는 디렉토리입니다. 예를 들어, japanese 관련 경로는 japanese.py에, known 관련 경로는 known.py에 정의합니다.
• tests/: FastAPI 애플리케이션의 테스트 코드를 포함하는 디렉토리입니다. 여기에는 데이터베이스 연결 테스트, API 엔드포인트 테스트 등이 포함될 수 있습니다.
• requirements.txt: 프로젝트에 필요한 Python 패키지 목록입니다. 예를 들어, fastapi, uvicorn, pydantic, SQLAlchemy, mysql-connector-python 등이 포함될 수 있습니다.

 

• database.py

MySQL 데이터베이스와 연결을 관리하는 코드입니다. SQLAlchemy create_engine 함수를 사용하여 데이터베이스 엔진을 생성하고, SessionLocal 클래스를 사용하여 데이터베이스 세션을 관리합니다.

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker
import os
from dotenv import load_dotenv

load_dotenv()

DATABASE_URL = os.getenv("DATABASE_URL")

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

Base = declarative_base()

• models.py

데이터베이스 모델을 SQLAlchemy ORM을 사용하여 정의합니다. 예를 들어, Japanese와 Known 테이블을 정의할 수 있습니다.

from sqlalchemy import Column, Integer, String, Date
from .database import Base

class Japanese(Base):
    __tablename__ = "japanese"
    
    id = Column(Integer, primary_key=True, index=True)
    word = Column(String, index=True)
    meaning = Column(String)

class Known(Base):
    __tablename__ = "known"
    
    id = Column(Integer, primary_key=True, index=True)
    word_id = Column(Integer, index=True)
    review_date = Column(Date)