# saiteja013526/socialmediaapi architecture

> Architecture diagram of the GitHub repository saiteja013526/socialmediaapi, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/saiteja013526/socialmediaapi
- Repository: https://github.com/saiteja013526/socialmediaapi

## Overview

##### Project type and purpose
- This is a standalone backend REST API for a social-media-style application, built in Python using FastAPI.
- Core features: user registration & JWT login, CRUD operations on posts, data validation with Pydantic, persistence via SQLAlchemy + PostgreSQL.

##### File structure
- Top-level “app” folder contains the FastAPI app:
– main.py: application entrypoint (Uvicorn + FastAPI instantiation)
– config.py: environment and settings loader
– database.py: SQLAlchemy engine, session management
– models.py: ORM model definitions
– oauth_2.py: JWT token creation and verification logic
– schemas.py: Pydantic request/response models
– utils.py: helper functions (e.g. password hashing)
– routers/: directory with separate routers for auth, user, and post endpoints
- requirements.txt lists dependencies (FastAPI, SQLAlchemy, uvicorn, etc.)

##### README for additional insights
- Confirms stack: FastAPI, PostgreSQL, SQLAlchemy, JWT (Passlib), Uvicorn
- Emphasizes the standard layered approach: HTTP endpoints → validation → business logic → data persistence

a. Main components
- Client (Swagger UI / Postman / Frontend App)
- API Server (Uvicorn + FastAPI)
- Router Layer: AuthRouter, UserRouter, PostRouter
- Service / Business Logic Layer (utils, oauth2, any helper functions)
- Data Access Layer: SQLAlchemy session, models
- Database: PostgreSQL instance
- External services: JWT signing service (built-in), environment configuration (.env)
b. Relationships and interactions
1. Client → HTTP request → API Server
2. API Server dispatches request to the appropriate Router
3. Router uses Pydantic schemas to validate input
4. Router calls business-logic helpers (utils, oauth2)
5. Business logic invokes SQLAlchemy session to query/update DB
6. DB returns results → business logic returns domain objects → routers serialize using schemas → HTTP response back to client
c. Architectural patterns and design principles
- Layered architecture (Presentation / API layer, Validation, Business logic, Persistence)
- Separation of concerns: each router handles one resource
- Dependency injection style for DB sessions and settings
- Stateless authentication via JWT
d. Key technologies/frameworks
- FastAPI + Uvicorn (ASGI server)
- Pydantic (input/output validation)
- SQLAlchemy (ORM)
- PostgreSQL (relational database)
- Passlib + PyJWT (password hashing & token handling)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    SW["Swagger UI"]:::external
    FE["Frontend App"]:::external

    %% API Server
    FS["FastAPI App"]:::api

    %% Configuration & External
    Config["Config Loader"]:::external
    Requirements["requirements.txt"]:::external
    Demo["demo.py"]:::external

    %% Layers
    subgraph "API Layer"
        AuthR["AuthRouter"]:::api
        UserR["UserRouter"]:::api
        PostR["PostRouter"]:::api
        Schemas["Pydantic Schemas"]:::api
    end

    subgraph "Business Layer"
        OAuth["JWT Auth Logic"]:::business
        Utils["Utils / Business Helpers"]:::business
    end

    subgraph "Persistence Layer"
        DBEngine["Database Engine & Session"]:::dblayer
        Models["ORM Model Definitions"]:::dblayer
    end

    Postgres[(PostgreSQL DB)]:::dblayer

    %% Connections
    SW --> FS
    FE --> FS
    FS --> AuthR
    FS --> UserR
    FS --> PostR
    AuthR --> Schemas
    UserR --> Schemas
    PostR --> Schemas
    AuthR --> OAuth
    UserR --> Utils
    PostR --> Utils
    OAuth --> DBEngine
    Utils --> DBEngine
    DBEngine --> Models
    DBEngine --> Postgres
    Config --> FS
    Config --> DBEngine
    Config --> OAuth

    %% Click Events
    click FS "https://github.com/saiteja013526/socialmediaapi/blob/main/app/main.py"
    click Config "https://github.com/saiteja013526/socialmediaapi/blob/main/app/config.py"
    click DBEngine "https://github.com/saiteja013526/socialmediaapi/blob/main/app/database.py"
    click Models "https://github.com/saiteja013526/socialmediaapi/blob/main/app/models.py"
    click Schemas "https://github.com/saiteja013526/socialmediaapi/blob/main/app/schemas.py"
    click OAuth "https://github.com/saiteja013526/socialmediaapi/blob/main/app/oauth_2.py"
    click Utils "https://github.com/saiteja013526/socialmediaapi/blob/main/app/utils.py"
    click AuthR "https://github.com/saiteja013526/socialmediaapi/blob/main/app/routers/auth.py"
    click UserR "https://github.com/saiteja013526/socialmediaapi/blob/main/app/routers/user.py"
    click PostR "https://github.com/saiteja013526/socialmediaapi/blob/main/app/routers/post.py"
    click Demo "https://github.com/saiteja013526/socialmediaapi/blob/main/demo.py"
    click Requirements "https://github.com/saiteja013526/socialmediaapi/blob/main/requirements.txt"

    %% Styles
    classDef api fill:#D0E6FA,stroke:#0366d6
    classDef business fill:#FFD8A8,stroke:#FB8C00
    classDef dblayer fill:#D4EFDF,stroke:#27AE60
    classDef external fill:#E3E3E3,stroke:#AAAAAA
```
