How wpcodevo/fastapi_mongodb works
Project type and purpose
• This is a backend-only, Docker-orchestrated RESTful API service built with Python’s FastAPI framework.
• It provides user registration, email verification, JWT-based authentication, and CRUD operations on “posts,” all persisted in a MongoDB database.
File structure
• Top-level files:
• docker-compose.yml: defines containers for the app and MongoDB
• Makefile, requirements.txt, .env: build & environment configuration
• app/ directory layers:
• config.py & .env: application configuration via Pydantic
• database.py: establishes MongoDB connection (PyMongo)
• email.py & templates/: SMTP client + Jinja2 HTML email templates
• oauth2.py & utils.py: JWT signing, token verification, and password utilities
• routers/: FastAPI router modules (auth.py, user.py, post.py)
• schemas.py: Pydantic models for request/response validation
• serializers/: BSON-to-JSON mappers for MongoDB documents
• main.py: initializes FastAPI app, middleware (CORS), mounts routers
README for additional insights
• Confirms three main features: JWT auth, email verification, CRUD operations
• Emphasizes Docker Compose to spin up FastAPI + MongoDB
• Uses FastAPI JWT Auth package, PyMongo, Jinja2
a. Components
1. API Container (FastAPI app)
• Configuration module
• Router layer (auth, user, post)
• Service/utility layer (database client, JWT utils, email sender)
• Serialization/schema layer (Pydantic + custom serializers)
2. MongoDB Container (data store)
3. SMTP Server / Email Provider (external)
4. Clients
• Web/mobile clients (Postman, frontend apps) interacting via HTTP
b. Relationships & data flow
• Clients → FastAPI HTTP endpoints
• FastAPI Routers call controllers → utilities
• Database client (PyMongo) ↔ MongoDB
• JWT utils ↔ router dependency for protected routes
• Email sender uses SMTP to dispatch verification emails
c. Architectural patterns & design principles
• Layered architecture: API layer, business logic layer, data access layer
• Dependency injection in FastAPI (router dependencies for DB, auth)
• Separation of concerns: schemas vs. serializers vs. routers vs. utils
• Containerization (Docker Compose) for environment reproducibility
d. Key technologies & frameworks
• FastAPI (ASGI server)
• Pydantic (settings, schemas)
• PyMongo (database driver)
• FastAPI-JWT-Auth (JWT handling)
• Jinja2 (email templates)
• Docker Compose (container orchestration)