Configuración
Runtime
La API es una aplicación NestJS ejecutada sobre Node.js. La persistencia se realiza con MongoDB mediante Mongoose.
Variables de entorno
| Variable | Obligatoria | Descripción |
|---|---|---|
PORT |
No | Puerto HTTP donde escucha la aplicación. Si no se define, usa el valor por defecto del código. |
MONGODB_URI |
Si en ambientes reales | Cadena de conexión a MongoDB. No debe documentarse ni commitearse con valores reales. |
CORS_ORIGIN |
No | Lista de orígenes permitidos separados por coma. Si no se define, el código permite cualquier origen. |
Health check
GET /health
Respuesta esperada:
{
"status": true,
"service": "suppliers-api",
"msg": "OK"
}
Scripts NPM
| Script | Descripción |
|---|---|
npm run start |
Inicia NestJS |
npm run start:dev |
Inicia NestJS en modo watch |
npm run build |
Compila la aplicación |
npm run start:prod |
Ejecuta dist/main |
npm run test |
Ejecuta pruebas unitarias |
npm run test:e2e |
Ejecuta pruebas e2e |
npm run lint |
Ejecuta ESLint con autofix |
npm run format |
Formatea archivos TS con Prettier |
Validación de requests
En main, la aplicación registra un ValidationPipe global con:
whitelist: trueforbidNonWhitelisted: truetransform: true
Esto significa que NestJS rechaza propiedades no declaradas en los DTOs y transforma valores cuando los DTOs lo indican, por ejemplo requiresInvoice y leadTimeDays.