README.md

Simple FastAPI CRUD Example

📌 Features

• 240727 created, Python 3.12.x, fastapi~=0.111.1, pydantic~=2.8.2, sqlmodel~=0.0.21
  • PostgreSQL
  • Create an initial user
  • endpoints CRUD
    • member
  • API healthcheck
  • Complete swagger Api info
    • Swagger
      • http://localhost:8000/swagger
    • Redoc
      • http://localhost:8000/redoc
    • OpenAPI
      • http://localhost:8000/openapi.json

💾 Installation

python -m pip install --upgrade pip
pip install -r requirements-dev.txt

🔧 Config

• .env.example을 복사, 참고 하여 .env 파일 작성
  • 별도 수정 없이 docker 내에서 실행 시, POSTGRES_HOST의 localhost ->host.docker.internal || postgres

🏃 Run

# http
uvicorn app.main:app

# dev 
uvicorn app.main:app --reload

# docker 
docker-compose up --build -d

# db only
docker run -e POSTGRES_PASSWORD=postgres -e POSTGRES_USER=postgres -e POSTGRES_DATABASE=postgres -e -p 5432:5432 --name postgres -d postgres