How aghazaryan/package-api works
Package API is a NestJS backend for creating, reading, updating, deleting, bulk-managing, and paginating package records. Requests enter the package controller, are delegated to the service, and use a TypeORM repository configured for PostgreSQL. The main entry point configures validation and Swagger. DTOs define request shapes and validation; the excerpts do not show the full persistence behavior beyond the service’s repository calls and the module’s database configuration.
Main entry points: package.module.ts Package module · package.controller.ts Package routes · package.service.ts Package service · main.ts HTTP bootstrap
Components 10
Application runtime
- HTTP bootstrap
src/main.ts - Application module
src/app.module.ts - Swagger docs
src/main.ts
Package API
- Package routes
src/package/package.controller.ts - Request DTOs
src/package/dto - Package service
src/package/package.service.ts - Package module
src/package/package.module.ts
Package persistence
- Package entity
src/package/package.entity.ts - PostgreSQL
Other components
- API client
Connections 12
- API client → Package routes: sends requests
src/package/package.controller.ts - HTTP bootstrap → Application module: bootstraps
src/main.ts - HTTP bootstrap → Swagger docs: configures docs
src/main.ts - Application module → Package module: imports
src/app.module.ts - Package routes → Package service: delegates operations
src/package/package.controller.ts - Package routes → Request DTOs: accepts request shapes
src/package/package.controller.ts - Package service → Package entity: uses repository entity
src/package/package.service.ts - Package module → Package service: provides
src/package/package.module.ts - Package module → Package routes: registers
src/package/package.module.ts - Package module → Package entity: registers ORM entity
src/package/package.module.ts - Package module → PostgreSQL: configures connection
src/package/package.module.ts - Package service → PostgreSQL: reads and writes records