Skip to content

ever-co/ever-works / .agents/skills/nestjs-best-practices

nestjs-best-practices

Verified

NestJS best practices and architecture patterns for building production-ready applications. This skill should be used when writing, reviewing, or refactoring NestJS code to ensure proper patterns for modules, dependency injection, security, and performance.

FileKindSize
AGENTS.mdmarkdown154.2 KB
README.mdmarkdown4.7 KB
SKILL.mdskill md4.8 KB
rules/_sections.mdmarkdown2.1 KB
rules/_template.mdmarkdown633 B
rules/api-use-dto-serialization.mdmarkdown4.2 KB
rules/api-use-interceptors.mdmarkdown5.4 KB
rules/api-use-pipes.mdmarkdown5.3 KB
rules/api-versioning.mdmarkdown4.7 KB
rules/arch-avoid-circular-deps.mdmarkdown1.9 KB
rules/arch-feature-modules.mdmarkdown2.3 KB
rules/arch-module-sharing.mdmarkdown3.7 KB
rules/arch-single-responsibility.mdmarkdown2.8 KB
rules/arch-use-events.mdmarkdown2.9 KB
rules/arch-use-repository-pattern.mdmarkdown2.7 KB
rules/db-avoid-n-plus-one.mdmarkdown3.8 KB
rules/db-use-migrations.mdmarkdown3.7 KB
rules/db-use-transactions.mdmarkdown3.6 KB
rules/devops-graceful-shutdown.mdmarkdown5.5 KB
rules/devops-use-config-module.mdmarkdown4.2 KB
rules/devops-use-logging.mdmarkdown5.1 KB
rules/di-avoid-service-locator.mdmarkdown2.8 KB
rules/di-interface-segregation.mdmarkdown5.0 KB
rules/di-liskov-substitution.mdmarkdown6.8 KB
rules/di-prefer-constructor-injection.mdmarkdown2.2 KB
rules/di-scope-awareness.mdmarkdown2.5 KB
rules/di-use-interfaces-tokens.mdmarkdown2.5 KB
rules/error-handle-async-errors.mdmarkdown3.4 KB
rules/error-throw-http-exceptions.mdmarkdown3.0 KB
rules/error-use-exception-filters.mdmarkdown3.4 KB
rules/micro-use-health-checks.mdmarkdown6.1 KB
rules/micro-use-patterns.mdmarkdown5.0 KB
rules/micro-use-queues.mdmarkdown5.7 KB
rules/perf-async-hooks.mdmarkdown2.8 KB
rules/perf-lazy-loading.mdmarkdown3.6 KB
rules/perf-optimize-database.mdmarkdown3.0 KB
rules/perf-use-caching.mdmarkdown3.3 KB
rules/security-auth-jwt.mdmarkdown3.8 KB
rules/security-rate-limiting.mdmarkdown3.1 KB
rules/security-sanitize-output.mdmarkdown3.7 KB
rules/security-use-guards.mdmarkdown3.4 KB
rules/security-validate-all-input.mdmarkdown3.2 KB
rules/test-e2e-supertest.mdmarkdown4.4 KB
rules/test-mock-external-services.mdmarkdown4.2 KB
rules/test-use-testing-module.mdmarkdown4.1 KB
scripts/build-agents.tsscript8.1 KB
scripts/build.shscript369 B
scripts/package-lock.jsonmanifest7.7 KB
scripts/package.jsonmanifest410 B

rules/api-versioning.md

View on GitHub
---
title: Use API Versioning for Breaking Changes
impact: MEDIUM
impactDescription: Versioning allows you to evolve APIs without breaking existing clients
tags: api, versioning, breaking-changes, compatibility
---

## Use API Versioning for Breaking Changes

Use NestJS built-in versioning when making breaking changes to your API. Choose a versioning strategy (URI, header, or media type) and apply it consistently. This allows old clients to continue working while new clients use updated endpoints.

**Incorrect (breaking changes without versioning):**

```typescript
// Breaking changes without versioning
@Controller('users')
export class UsersController {
	@Get(':id')
	async findOne(@Param('id') id: string): Promise<User> {
		// Original response: { id, name, email }
		// Later changed to: { id, firstName, lastName, emailAddress }
		// Old clients break!
		return this.usersService.findOne(id);
	}
}

// Manual versioning in routes
@Controller('v1/users')
export class UsersV1Controller {}

@Controller('v2/users')
export class UsersV2Controller {}
// Inconsistent, error-prone, hard to maintain
```

**Correct (use NestJS built-in versioning):**

```typescript
// Enable versioning in main.ts
async function bootstrap() {
	const app = await NestFactory.create(AppModule);

	// URI versioning: /v1/users, /v2/users
	app.enableVersioning({
		type: VersioningType.URI,
		defaultVersion: '1'
	});

	// Or header versioning: X-API-Version: 1
	app.enableVersioning({
		type: VersioningType.HEADER,
		header: 'X-API-Version',
		defaultVersion: '1'
	});

	// Or media type: Accept: application/json;v=1
	app.enableVersioning({
		type: VersioningType.MEDIA_TYPE,
		key: 'v=',
		defaultVersion: '1'
	});

	await app.listen(3000);
}

// Version-specific controllers
@Controller('users')
@Version('1')
export class UsersV1Controller {
	@Get(':id')
	async findOne(@Param('id') id: string): Promise<UserV1Response> {
		const user = await this.usersService.findOne(id);
		// V1 response format
		return {
			id: user.id,
			name: user.name,
			email: user.email
		};
	}
}

@Controller('users')
@Version('2')
export class UsersV2Controller {
	@Get(':id')
	async findOne(@Param('id') id: string): Promise<UserV2Response> {
		const user = await this.usersService.findOne(id);
		// V2 response format with breaking changes
		return {
			id: user.id,
			firstName: user.firstName,
			lastName: user.lastName,
			emailAddress: user.email,
			createdAt: user.createdAt
		};
	}
}

// Per-route versioning - different versions for different routes
@Controller('users')
export class UsersController {
	@Get()
	@Version('1')
	findAllV1(): Promise<UserV1Response[]> {
		return this.usersService.findAllV1();
	}

	@Get()
	@Version('2')
	findAllV2(): Promise<UserV2Response[]> {
		return this.usersService.findAllV2();
	}

	@Get(':id')
	@Version(['1', '2']) // Same handler for multiple versions
	findOne(@Param('id') id: string): Promise<User> {
		return this.usersService.findOne(id);
	}

	@Post()
	@Version(VERSION_NEUTRAL) // Available in all versions
	create(@Body() dto: CreateUserDto): Promise<User> {
		return this.usersService.create(dto);
	}
}

// Shared service with version-specific logic
@Injectable()
export class UsersService {
	async findOne(id: string, version: string): Promise<any> {
		const user = await this.repo.findOne({ where: { id } });

		if (version === '1') {
			return this.toV1Response(user);
		}
		return this.toV2Response(user);
	}

	private toV1Response(user: User): UserV1Response {
		return {
			id: user.id,
			name: `${user.firstName} ${user.lastName}`,
			email: user.email
		};
	}

	private toV2Response(user: User): UserV2Response {
		return {
			id: user.id,
			firstName: user.firstName,
			lastName: user.lastName,
			emailAddress: user.email,
			createdAt: user.createdAt
		};
	}
}

// Controller extracts version
@Controller('users')
export class UsersController {
	@Get(':id')
	async findOne(@Param('id') id: string, @Headers('X-API-Version') version: string = '1'): Promise<any> {
		return this.usersService.findOne(id, version);
	}
}

// Deprecation strategy - mark old versions as deprecated
@Controller('users')
@Version('1')
@UseInterceptors(DeprecationInterceptor)
export class UsersV1Controller {
	// All V1 routes will include deprecation warning
}

@Injectable()
export class DeprecationInterceptor implements NestInterceptor {
	intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
		const response = context.switchToHttp().getResponse();
		response.setHeader('Deprecation', 'true');
		response.setHeader('Sunset', 'Sat, 1 Jan 2025 00:00:00 GMT');
		response.setHeader('Link', '</v2/users>; rel="successor-version"');

		return next.handle();
	}
}
```

Reference: [NestJS Versioning](https://docs.nestjs.com/techniques/versioning)
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall