🔨개발 기초 공사

앞으로 만들 "파이보"가 완성된 빌딩이라면 여기는 기초 공사에 해당한다.

이 장의 목표

• APIRouter를 이용해 라우트 함수를 관리한다.
• SQLAlchemy를 이용해 데이터베이스를 제어한다.
• 파이보 게시판에 질문 목록과 상세 조회 기능을 만든다.

FastAPI 기초 다지기

현재 파이보 프로젝트는 projects/myapi 디렉터리 아래에 main.py 파일만 생성한 상태 규모를 갖춘 FastAPI 프로젝트를 만들고자 한다면 프로젝트 구조를 잘 만들어야 한다. 그런데 FastAPI는 "프로젝트의 구조를 어떻게 하라"와 같은 규칙이 없으므로 프로젝트를 구성할 때 고민을 해야 한다.

FastAPI 프로젝트 구조

├── main.py ├── database.py ├── models.py ├── domain │   ├── answer │   ├── question │   └── user └── frontend

1. 파이보 프로젝트를 설정하는 main.py 파일
   • FastAPI 프로젝트의 전체적인 환경을 설정하는 파일
   • 해당 파일에 생성한 app 객체는 FastAPI의 핵심 객체, 이를 통해 FastAPI의 설정을 할 수 있음
2. DB를 설정하는 database.py
   • DB와 관련된 설정을 하는 파일
   • DB를 사용하기 위한 변수, 함수등을 정의하고, 접속할 DB의 주소와 사용자, 비밀번호등을 관리
3. 모델을 관리하는 models.py 파일
   • 해당 프로젝트는 ORM을 지원하는 파이썬 데이터베이스 도구인 SQLAlchemy를 사용
   • 즉, 모델 클래스들을 정의할 models.py 파일이 필요하다.
4. API를 구성하는 domain 디렉터리
   • 이 프로젝트는 질문과 답변을 작성하는 게시판을 만드는 것을 최종 목표로 함.
   • 이에 "질문", "답변", "사용자" 라는 총 3개의 도메인을 두어 그 하위에 관련된 파일을 작성. 그리고 각 도메인은 API를 생성하기 위해서 다음과 같은 파일들이 필요하다.
     • 라우터 파일 - URL과 API의 전체적인 동작을 관리
     • 데이터베이스 처리 파일 - 데이터의 생성(Create), 조회(Read), 수정(Update), 삭제(Delete)를 처리 (CRUD)
     • 입출력 관리 파일 - 입/출력 데이터의 스펙 정의 및 검증
   • 예를 들어 질문(domain/question) 도메인이라면 다음의 3개 파일이 필요
     • question_router.py - 라우터 파일
     • question_crud.py - 데이터베이스 처리 파일
     • question_schema.py - 입출력 관리 파일
5. frontend
   • Svelte 프레임워크를 설치한 디렉터리. Svelte의 소스 및 빌드 파일들을 저장할 프론트엔드의 루트 디렉터리이다.
   • 최종적으로 frontend/dist 디렉터리에 생성된 빌드 파일들을 배포시에 사용할 것

모델로 데이터베이스 관리하기

우리가 만들 프로젝트는 질문/답변 게시판이다. 질문이나 답변을 작성시 데이터가 생성됨.