# yuvarajucet/bookmark-api architecture

> Architecture diagram of the GitHub repository yuvarajucet/bookmark-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yuvarajucet/bookmark-api
- Repository: https://github.com/yuvarajucet/bookmark-api

## Overview

bookmark-api is a FastAPI service for account registration, verification, login and password recovery, plus authenticated bookmark/category management. Requests enter through the application’s mounted routers; handlers validate inputs and delegate to controllers, which use a SQLite schema. Account email workflows send verification or reset messages. The README gives setup guidance but no additional product capabilities. Edges reflect shown calls or imports; admin and settings internals are not sampled, so their behavior is not expanded.

Main entry points: [`routes/user.py`](https://github.com/yuvarajucet/bookmark-api/blob/development/routes/user.py) (User routes), [`dbController/userDBController.py`](https://github.com/yuvarajucet/bookmark-api/blob/development/dbController/userDBController.py) (User controller), [`app.py`](https://github.com/yuvarajucet/bookmark-api/blob/development/app.py) (FastAPI application), [`routes/bookmark.py`](https://github.com/yuvarajucet/bookmark-api/blob/development/routes/bookmark.py) (Bookmark routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API routing"]
  node_application["FastAPI application<br/>[app.py]"]
  node_user_routes["User routes<br/>[user.py]"]
  node_bookmark_routes["Bookmark routes<br/>[bookmark.py]"]
  node_admin_routes["Admin routes<br/>[admin.py]"]
  node_settings_routes["Settings routes<br/>[userSettings.py]"]
  node_admin_controller["Admin controller"]
end

subgraph group_identity["Accounts and auth"]
  node_user_schemas["User schemas<br/>[user.py]"]
  node_user_controller["User controller"]
  node_jwt_guard["JWT request guard<br/>[athenticateUser.py]"]
  node_jwt_handler["JWT handler"]
  node_email_service["Email service<br/>[emailHelper.py]"]
end

subgraph group_bookmarks["Bookmark management"]
  node_bookmark_schemas["Bookmark schemas<br/>[bookmark.py]"]
  node_bookmark_controller["Bookmark controller"]
  node_bookmark_helper["Bookmark helper<br/>[boomarkHelper.py]"]
end

subgraph group_persistence["Persistence"]
  node_sqlite_schema[("SQLite schema<br/>[model.py]")]
end

subgraph group_support["Shared services"]
  node_user_helper["User helper<br/>[userHelper.py]"]
end

node_client(("API client"))
node_smtp["SMTP email service"]

node_client -->|"sends requests"| node_application
node_application -->|"mounts"| node_user_routes
node_application -->|"mounts"| node_bookmark_routes
node_application -->|"mounts"| node_admin_routes
node_application -->|"mounts"| node_settings_routes
node_user_routes -->|"accepts"| node_user_schemas
node_user_routes -->|"calls"| node_user_controller
node_user_routes -->|"calls"| node_user_helper
node_user_routes -->|"calls"| node_email_service
node_user_routes -->|"guards routes"| node_jwt_guard
node_email_service -->|"requests reset token"| node_user_controller
node_email_service -->|"sends mail"| node_smtp
node_user_controller -->|"uses"| node_user_schemas
node_user_controller -->|"calls"| node_user_helper
node_user_controller -->|"signs tokens"| node_jwt_handler
node_jwt_guard -->|"decodes token"| node_jwt_handler
node_bookmark_routes -->|"accepts"| node_bookmark_schemas
node_bookmark_routes -->|"calls"| node_bookmark_controller
node_bookmark_routes -->|"generates and fetches"| node_bookmark_helper
node_bookmark_routes -->|"guards routes"| node_jwt_guard
node_bookmark_controller -->|"uses"| node_bookmark_schemas
node_bookmark_controller -->|"decodes token"| node_jwt_handler
node_user_controller -->|"queries"| node_sqlite_schema
node_bookmark_controller -->|"queries"| node_sqlite_schema
node_admin_routes -->|"calls"| node_admin_controller
node_admin_controller -->|"imports schema"| node_sqlite_schema

click node_application "https://github.com/yuvarajucet/bookmark-api/blob/development/app.py"
click node_user_routes "https://github.com/yuvarajucet/bookmark-api/blob/development/routes/user.py"
click node_bookmark_routes "https://github.com/yuvarajucet/bookmark-api/blob/development/routes/bookmark.py"
click node_admin_routes "https://github.com/yuvarajucet/bookmark-api/blob/development/routes/admin.py"
click node_settings_routes "https://github.com/yuvarajucet/bookmark-api/blob/development/routes/userSettings.py"
click node_user_schemas "https://github.com/yuvarajucet/bookmark-api/blob/development/schemas/user.py"
click node_user_controller "https://github.com/yuvarajucet/bookmark-api/blob/development/dbController/userDBController.py"
click node_jwt_guard "https://github.com/yuvarajucet/bookmark-api/blob/development/auth/athenticateUser.py"
click node_jwt_handler "https://github.com/yuvarajucet/bookmark-api/blob/development/auth/authenticateHandler.py"
click node_email_service "https://github.com/yuvarajucet/bookmark-api/blob/development/helper/emailHelper.py"
click node_bookmark_schemas "https://github.com/yuvarajucet/bookmark-api/blob/development/schemas/bookmark.py"
click node_bookmark_controller "https://github.com/yuvarajucet/bookmark-api/blob/development/dbController/bookmarkDBController.py"
click node_bookmark_helper "https://github.com/yuvarajucet/bookmark-api/blob/development/helper/boomarkHelper.py"
click node_admin_controller "https://github.com/yuvarajucet/bookmark-api/blob/development/dbController/adminDBController.py"
click node_user_helper "https://github.com/yuvarajucet/bookmark-api/blob/development/helper/userHelper.py"
click node_sqlite_schema "https://github.com/yuvarajucet/bookmark-api/blob/development/models/model.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_application,node_user_routes,node_bookmark_routes,node_admin_routes,node_settings_routes,node_admin_controller,node_client toneBlue
class node_user_schemas,node_user_controller,node_jwt_guard,node_jwt_handler,node_email_service toneAmber
class node_bookmark_schemas,node_bookmark_controller,node_bookmark_helper toneMint
class node_sqlite_schema toneRose
class node_user_helper,node_smtp toneIndigo
```

## Components

### API routing

- [FastAPI application](https://github.com/yuvarajucet/bookmark-api/blob/development/app.py): `app.py`
- [User routes](https://github.com/yuvarajucet/bookmark-api/blob/development/routes/user.py): `routes/user.py`
- [Bookmark routes](https://github.com/yuvarajucet/bookmark-api/blob/development/routes/bookmark.py): `routes/bookmark.py`
- [Admin routes](https://github.com/yuvarajucet/bookmark-api/blob/development/routes/admin.py): `routes/admin.py`
- [Settings routes](https://github.com/yuvarajucet/bookmark-api/blob/development/routes/userSettings.py): `routes/userSettings.py`
- [Admin controller](https://github.com/yuvarajucet/bookmark-api/blob/development/dbController/adminDBController.py): `dbController/adminDBController.py`

### Accounts and auth

- [User schemas](https://github.com/yuvarajucet/bookmark-api/blob/development/schemas/user.py): `schemas/user.py`
- [User controller](https://github.com/yuvarajucet/bookmark-api/blob/development/dbController/userDBController.py): `dbController/userDBController.py`
- [JWT request guard](https://github.com/yuvarajucet/bookmark-api/blob/development/auth/athenticateUser.py): `auth/athenticateUser.py`
- [JWT handler](https://github.com/yuvarajucet/bookmark-api/blob/development/auth/authenticateHandler.py): `auth/authenticateHandler.py`
- [Email service](https://github.com/yuvarajucet/bookmark-api/blob/development/helper/emailHelper.py): `helper/emailHelper.py`

### Bookmark management

- [Bookmark schemas](https://github.com/yuvarajucet/bookmark-api/blob/development/schemas/bookmark.py): `schemas/bookmark.py`
- [Bookmark controller](https://github.com/yuvarajucet/bookmark-api/blob/development/dbController/bookmarkDBController.py): `dbController/bookmarkDBController.py`
- [Bookmark helper](https://github.com/yuvarajucet/bookmark-api/blob/development/helper/boomarkHelper.py): `helper/boomarkHelper.py`

### Persistence

- [SQLite schema](https://github.com/yuvarajucet/bookmark-api/blob/development/models/model.py): `models/model.py`

### Shared services

- [User helper](https://github.com/yuvarajucet/bookmark-api/blob/development/helper/userHelper.py): `helper/userHelper.py`

### Other components

- **API client**
- **SMTP email service**

## Connections

- API client → FastAPI application: sends requests (evidence: `app.py`)
- FastAPI application → User routes: mounts (evidence: `app.py`)
- FastAPI application → Bookmark routes: mounts (evidence: `app.py`)
- FastAPI application → Admin routes: mounts (evidence: `app.py`)
- FastAPI application → Settings routes: mounts (evidence: `app.py`)
- User routes → User schemas: accepts (evidence: `routes/user.py`)
- User routes → User controller: calls (evidence: `routes/user.py`)
- User routes → User helper: calls (evidence: `routes/user.py`)
- User routes → Email service: calls (evidence: `routes/user.py`)
- User routes → JWT request guard: guards routes (evidence: `routes/user.py`)
- Email service → User controller: requests reset token (evidence: `helper/emailHelper.py`)
- Email service → SMTP email service: sends mail (evidence: `helper/emailHelper.py`)
- User controller → User schemas: uses (evidence: `dbController/userDBController.py`)
- User controller → User helper: calls (evidence: `dbController/userDBController.py`)
- User controller → JWT handler: signs tokens (evidence: `dbController/userDBController.py`)
- JWT request guard → JWT handler: decodes token (evidence: `auth/athenticateUser.py`)
- Bookmark routes → Bookmark schemas: accepts (evidence: `routes/bookmark.py`)
- Bookmark routes → Bookmark controller: calls (evidence: `routes/bookmark.py`)
- Bookmark routes → Bookmark helper: generates and fetches (evidence: `routes/bookmark.py`)
- Bookmark routes → JWT request guard: guards routes (evidence: `routes/bookmark.py`)
- Bookmark controller → Bookmark schemas: uses (evidence: `dbController/bookmarkDBController.py`)
- Bookmark controller → JWT handler: decodes token (evidence: `dbController/bookmarkDBController.py`)
- User controller → SQLite schema: queries (evidence: `dbController/userDBController.py`)
- Bookmark controller → SQLite schema: queries (evidence: `dbController/bookmarkDBController.py`)
- Admin routes → Admin controller: calls (evidence: `routes/admin.py`)
- Admin controller → SQLite schema: imports schema (evidence: `dbController/adminDBController.py`)
