NestJS Controllers & Services Standards
Priority: P0 (FOUNDATIONAL)
Layer separation standards and dependency injection patterns for NestJS applications.
Controllers
- •
Role: Handler only. Delegate all logic to Services.
- •
Context: Use
ExecutionContexthelpers (switchToHttp()) for platform-agnostic code. - •
Custom Decorators:
- •Avoid:
@Request() req->req.user(Not type-safe). - •Pattern: Create typed decorators like
@CurrentUser(),@DeviceIp().
typescriptexport const CurrentUser = createParamDecorator( (data: unknown, ctx: ExecutionContext) => ctx.switchToHttp().getRequest().user, ); - •Avoid:
DTOs & Validation
- •Strictness:
- •
whitelist: true: Strip properties without decorators. - •Critical:
forbidNonWhitelisted: true: Throw error if unknown properties exist.
- •
- •Transformation:
- •
transform: true: Auto-convert primitives (String '1' -> Number 1) and instantiate DTO classes.
- •
- •Documentation:
- •Automation: Use the
@nestjs/swaggerCLI plugin (nest-cli.json) to auto-detect DTO properties without manual@ApiProperty()tags.
- •Automation: Use the
Interceptors (Response Mapping)
- •Standardization: specific responses should be mapped in Interceptors, not Controllers.
- •Use
map()to wrap success responses (e.g.{ data: T }). - •Refer to API Standards for
PageDtoandApiResponse. - •Use
catchError()to map low-level errors (DB constraints) toHttpException(e.g.ConflictException) before they hit the global filter.
- •Use
Services & Business Logic
- •Singleton: Default.
- •Stateless: Do not store request-specific state in class properties unless identifying as
Scope.REQUEST.
Pipes & Validation
- •Global: Register
ValidationPipeglobally. - •Route Params: Fail fast. Always use
ParseIntPipe,ParseUUIDPipeon all ID parameters.
typescript
@Get(':id')
findOne(@Param('id', ParseIntPipe) id: number) { ... }
Lifecycle Events
- •Init: Use
OnModuleInitfor connection setup. - •Destroy: Use
OnApplicationShutdownfor cleanup. (RequiresenableShutdownHooks()).