Skip to content

Latest commit

 

History

History
66 lines (57 loc) · 2.56 KB

README.md

File metadata and controls

66 lines (57 loc) · 2.56 KB
Raw

프로젝트 설명

  • FastAPI를 사용하여 API 서버입니다.
  • python 3.10 버전을 사용합니다.

프로젝트

프로젝트 폴더 구조

├── README.md
├── app
│   ├── config
│   │   ├── __init__.py
│   │   └── aws -- 예시: aws 설정 폴더
│   ├── database
│   │   ├── __init__.py
│   │   └── 각종 데이터베이스 설정 파일 
│   ├── models
│   │   ├── __init__.py
│   │   └── 각종 모델 파일
│   ├── routers
│   │   ├── __init__.py
│   │   └── 각종 라우터 파일
│   ├── services
│   │   ├── __init__.py
│   │   └── 각종 서비스 파일
│   ├── middlewares
│   │   ├── __init__.py
│   │   └── 각종 미들웨어 파일
│   └── schemas
│       ├── __init__.py
│       └── 각종 스키마 파일
├── requirements.txt
└── .gitignore

config (예: aws ...)

  • 각종 설정을 관리하는 폴더로 환경 변수를 관리합니다
  • 환경 변수인 .env의 내용을 가져와 설정을 하는 역할을 합니다
  • 예시로 aws 설정 폴더를 만들어서 aws 설정 파일을 관리합니다

services

  • 각종 서비스 파일을 관리하는 폴더로 비즈니스 로직을 처리합니다
  • 각종 서비스 파일을 만들어서 비즈니스 로직을 처리합니다
  • 비즈니스 로직이란 데이터베이스에 접근하여 데이터를 가져오거나 저장하는 로직을 말합니다

models

  • 각종 모델 파일을 관리하는 폴더로 데이터베이스 모델을 정의합니다
  • 각종 모델 파일을 만들어서 데이터베이스 모델을 정의합니다
  • 데이터베이스 모델이란 데이터베이스의 테이블을 정의하는 클래스를 말합니다

middlewares

  • 각종 미들웨어 파일을 관리하는 폴더로 API 요청을 처리하기 전에 처리합니다
  • 각종 미들웨어 파일을 만들어서 API 요청을 처리하기 전에 처리합니다

schemas

  • 각종 스키마 파일을 관리하는 폴더로 API 요청에서 사용할 스키마를 정의합니다
  • 각종 스키마 파일을 만들어서 API 요청에서 사용할 스키마를 정의합니다

requirements.txt

  • 프로젝트에 사용된 라이브러리를 정의한 파일입니다
  • pip install -r requirements.txt 를 통해 라이브러리를 설치합니다

.gitignore

  • git에 올리지 않을 파일을 정의한 파일입니다
  • git에 올리지 않을 파일을 정의합니다