# itsananya252/api-replay architecture

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

- Interactive diagram: https://gitdiagram.com/itsananya252/api-replay
- Repository: https://github.com/itsananya252/api-replay

## Overview

API Replay turns recorded HTTP traffic into a regression suite: a servlet filter records requests and responses, replay sends saved GET calls to a target version, and reports compare responses and flag breaking changes. The backend also provides a sample users API and endpoints to inspect or clear recordings and review replay runs; the React UI exposes replay and report workflows. The README documents recording and replay behavior, while the replay service and UI implementation were not excerpted, so some internal links are omitted or marked unverified.

Main entry points: [`backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java`](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java) (Report builder), [`backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java`](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java) (Replay endpoints), [`backend/src/main/java/com/ananya/apireplay/controller/UserController.java`](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/UserController.java) (User endpoints), [`backend/src/main/java/com/ananya/apireplay/replay/ReplayService.java`](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/replay/ReplayService.java) (Replay runner)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_capture["Traffic capture"]
  node_recorder["Recorder filter"]
  node_recorded_store[("Recorded calls<br/>[RecordedCall.java]")]
  node_recorded_repo["Recording repository"]
  node_recorded_controller["Recording endpoints"]
end

subgraph group_replay["Replay and reports"]
  node_replay_controller["Replay endpoints"]
  node_replay_service["Replay runner<br/>[ReplayService.java]"]
  node_result_store[("Replay results<br/>[ReplayResult.java]")]
  node_result_repo["Result repository"]
  node_report_service["Report builder"]
  node_diff_engine["JSON diff engine"]
  node_diff_types["Diff entries and types<br/>[DiffEntry.java]"]
  node_report_dto["Report DTOs<br/>[ReplayReport.java]"]
  node_run_dto["Run response DTOs"]
  node_run_summary["Run summary<br/>[RunSummary.java]"]
end

subgraph group_api["Backend API"]
  node_user_controller["User endpoints"]
  node_user_repo["User repository"]
  node_user_entity[("User record<br/>[User.java]")]
  node_user_dto["User DTOs<br/>[UserRequest.java]"]
end

subgraph group_ui["Web interface"]
  node_frontend["Replay dashboard<br/>[App.jsx]"]
  node_frontend_entry["UI entry point<br/>[main.jsx]"]
  node_frontend_api["API client<br/>[api.js]"]
end

node_client(("API clients"))
node_target(("Target API"))

node_client -->|"sends traffic"| node_recorder
node_recorder -->|"records calls"| node_recorded_store
node_recorded_controller -->|"lists or clears"| node_recorded_repo
node_replay_controller -->|"starts replay"| node_replay_service
node_replay_service -.->|"loads saved calls"| node_recorded_repo
node_replay_service -->|"sends GET calls"| node_target
node_replay_controller -->|"builds CI report"| node_report_service
node_replay_controller -->|"lists run results"| node_result_repo
node_report_service -->|"loads run results"| node_result_repo
node_report_service -->|"compares bodies"| node_diff_engine
node_report_service -->|"builds report"| node_report_dto
node_diff_engine -->|"emits differences"| node_diff_types
node_user_controller -->|"reads and saves"| node_user_repo
node_user_controller -->|"maps users"| node_user_entity
node_user_controller -->|"accepts and returns"| node_user_dto
node_frontend_entry -->|"renders"| node_frontend
node_frontend_api -->|"requests replay API"| node_replay_controller
node_frontend_api -->|"requests recordings API"| node_recorded_controller

click node_recorder "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/recorder/RecorderFilter.java"
click node_recorded_store "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/entity/RecordedCall.java"
click node_recorded_repo "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/repository/RecordedCallRepository.java"
click node_recorded_controller "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/RecordedCallController.java"
click node_replay_controller "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java"
click node_replay_service "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/replay/ReplayService.java"
click node_result_store "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/entity/ReplayResult.java"
click node_result_repo "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/repository/ReplayResultRepository.java"
click node_report_service "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java"
click node_diff_engine "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/diff/JsonDiffEngine.java"
click node_diff_types "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/diff/DiffEntry.java"
click node_report_dto "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/ReplayReport.java"
click node_run_dto "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/ReplayRunResponse.java"
click node_run_summary "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/RunSummary.java"
click node_user_controller "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/UserController.java"
click node_user_repo "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/repository/UserRepository.java"
click node_user_entity "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/entity/User.java"
click node_user_dto "https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/UserRequest.java"
click node_frontend "https://github.com/itsananya252/api-replay/blob/main/frontend/src/App.jsx"
click node_frontend_entry "https://github.com/itsananya252/api-replay/blob/main/frontend/src/main.jsx"
click node_frontend_api "https://github.com/itsananya252/api-replay/blob/main/frontend/src/api.js"

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_recorder,node_recorded_store,node_recorded_repo,node_recorded_controller,node_client toneBlue
class node_replay_controller,node_replay_service,node_result_store,node_result_repo,node_report_service,node_diff_engine,node_diff_types,node_report_dto,node_run_dto,node_run_summary toneAmber
class node_user_controller,node_user_repo,node_user_entity,node_user_dto,node_target toneMint
class node_frontend,node_frontend_entry,node_frontend_api toneRose
```

## Components

### Traffic capture

- [Recorder filter](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/recorder/RecorderFilter.java): `backend/src/main/java/com/ananya/apireplay/recorder/RecorderFilter.java`
- [Recorded calls](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/entity/RecordedCall.java): `backend/src/main/java/com/ananya/apireplay/entity/RecordedCall.java`
- [Recording repository](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/repository/RecordedCallRepository.java): `backend/src/main/java/com/ananya/apireplay/repository/RecordedCallRepository.java`
- [Recording endpoints](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/RecordedCallController.java): `backend/src/main/java/com/ananya/apireplay/controller/RecordedCallController.java`

### Replay and reports

- [Replay endpoints](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java): `backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java`
- [Replay runner](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/replay/ReplayService.java): `backend/src/main/java/com/ananya/apireplay/replay/ReplayService.java`
- [Replay results](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/entity/ReplayResult.java): `backend/src/main/java/com/ananya/apireplay/entity/ReplayResult.java`
- [Result repository](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/repository/ReplayResultRepository.java): `backend/src/main/java/com/ananya/apireplay/repository/ReplayResultRepository.java`
- [Report builder](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java): `backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java`
- [JSON diff engine](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/diff/JsonDiffEngine.java): `backend/src/main/java/com/ananya/apireplay/diff/JsonDiffEngine.java`
- [Diff entries and types](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/diff/DiffEntry.java): `backend/src/main/java/com/ananya/apireplay/diff/DiffEntry.java`
- [Report DTOs](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/ReplayReport.java): `backend/src/main/java/com/ananya/apireplay/dto/ReplayReport.java`
- [Run response DTOs](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/ReplayRunResponse.java): `backend/src/main/java/com/ananya/apireplay/dto/ReplayRunResponse.java`
- [Run summary](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/RunSummary.java): `backend/src/main/java/com/ananya/apireplay/dto/RunSummary.java`

### Backend API

- [User endpoints](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/controller/UserController.java): `backend/src/main/java/com/ananya/apireplay/controller/UserController.java`
- [User repository](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/repository/UserRepository.java): `backend/src/main/java/com/ananya/apireplay/repository/UserRepository.java`
- [User record](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/entity/User.java): `backend/src/main/java/com/ananya/apireplay/entity/User.java`
- [User DTOs](https://github.com/itsananya252/api-replay/blob/main/backend/src/main/java/com/ananya/apireplay/dto/UserRequest.java): `backend/src/main/java/com/ananya/apireplay/dto/UserRequest.java`

### Web interface

- [Replay dashboard](https://github.com/itsananya252/api-replay/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [UI entry point](https://github.com/itsananya252/api-replay/blob/main/frontend/src/main.jsx): `frontend/src/main.jsx`
- [API client](https://github.com/itsananya252/api-replay/blob/main/frontend/src/api.js): `frontend/src/api.js`

### Other components

- **API clients**
- **Target API**

## Connections

- API clients → Recorder filter: sends traffic (evidence: `README.md`)
- Recorder filter → Recorded calls: records calls (evidence: `README.md`)
- Recording endpoints → Recording repository: lists or clears (evidence: `backend/src/main/java/com/ananya/apireplay/controller/RecordedCallController.java`)
- Replay endpoints → Replay runner: starts replay (evidence: `backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java`)
- Replay runner → Recording repository: loads saved calls
- Replay runner → Target API: sends GET calls (evidence: `README.md`)
- Replay endpoints → Report builder: builds CI report (evidence: `backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java`)
- Replay endpoints → Result repository: lists run results (evidence: `backend/src/main/java/com/ananya/apireplay/controller/ReplayController.java`)
- Report builder → Result repository: loads run results (evidence: `backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java`)
- Report builder → JSON diff engine: compares bodies (evidence: `backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java`)
- Report builder → Report DTOs: builds report (evidence: `backend/src/main/java/com/ananya/apireplay/replay/ReplayReportService.java`)
- JSON diff engine → Diff entries and types: emits differences (evidence: `backend/src/main/java/com/ananya/apireplay/diff/JsonDiffEngine.java`)
- User endpoints → User repository: reads and saves (evidence: `backend/src/main/java/com/ananya/apireplay/controller/UserController.java`)
- User endpoints → User record: maps users (evidence: `backend/src/main/java/com/ananya/apireplay/controller/UserController.java`)
- User endpoints → User DTOs: accepts and returns (evidence: `backend/src/main/java/com/ananya/apireplay/controller/UserController.java`)
- UI entry point → Replay dashboard: renders (evidence: `frontend/src/main.jsx`)
- API client → Replay endpoints: requests replay API (evidence: `frontend/src/api.js`)
- API client → Recording endpoints: requests recordings API (evidence: `frontend/src/api.js`)
