Skip to content

Mocauto APIDocumentazione tecnica

Piattaforma backend NestJS per la gestione di veicoli, scadenze, spese, eventi e notifiche ยท API REST ยท Infrastruttura AWS via CDK

Quick start โ€‹

bash
# 1. Clona e installa
git clone <repo>
cd mocauto-api
npm install

# 2. Avvia i servizi di sviluppo
docker compose up -d         # postgres + mailhog

# 3. Prepara il database
npm run prisma:migrate

# 4. Avvia l'app
npm run start:dev            # http://localhost:3000

# 5. Apri questa documentazione
npm run docs:dev             # http://localhost:5173

Mappa rapida โ€‹

AreaQuando consultarla
AutenticazioneImplementare login mobile/web, refresh, reset password, social login.
ArchitetturaAggiungere un nuovo modulo, capire DTO/guard/interceptor/filter.
Filters & DTOCostruire query lista paginata o gestire le differenze APP vs BACKOFFICE.
Eventi / NotificheFunzionalitร  nuove introdotte dalla v0.0.47.
InfrastrutturaCapire dove vive ciascun servizio AWS e come fare deploy.

Convenzioni di scrittura โ€‹

  • snake_case sui body/query/response delle API REST
  • camelCase all'interno del codice NestJS (Interceptor SnakeToCamelInterceptor gestisce la conversione)
  • Tutte le date in formato YYYY-MM-DD per i campi Date, ISO 8601 per i DateTime
  • Risposte di errore con error_code strutturato (vedi Exception Filters)

Documentazione tecnica Mocauto API ยท NestJS + Prisma + AWS CDK