How do you apply versioning at controller and method level in NestJS and how do you mark a route as version-neutral?

Q: How do you apply versioning at controller and method level in NestJS and how do you mark a route as version-neutral?

// Controller-level version — all routes in this controller are v1 @Controller({ path: 'users', version: '1' }) export class UsersV1Controller { @Get() findAll() { return 'v1 users'; } } // Method-level override — this route is v2, controller default is v1 @Controller({ path: 'users', version: '1' }) export class UsersController { @Get() findAll() { return 'v1 list'; } @Version('2') @Get() findAllV2() { return 'v2 list'; } } // Multiple versions on one handler @Version(['1', '2']) @Get() findAllShared() { return 'shared for v1 and v2'; } // VERSION_NEUTRAL — accessible at ALL versions and unversioned requests import { VERSION_NEUTRAL } from '@nestjs/common'; @Version(VERSION_NEUTRAL) @Get('health') healthCheck() { return { status: 'ok' }; } @Controller({ path, version }) sets the default version for all routes in the controller. @Version() on a method overrides the controller-level version for that specific route. @Version(['1', '2']) serves the same handler for multiple versions — reduces duplication for stable routes. VERSION_NEUTRAL makes the route accessible regardless of which version the client requests. Routes with no version annotation are only accessible when no versioning prefix is applied.

Difficulty: 5/10

controller versioning, method versioning, version-neutral routes

Apply @Controller({ path, version }) for controller-level versioning and @Version() on individual methods to override or add versions. Use @Version(['1', '2']) to handle multiple versions with one handler. Use VERSION_NEUTRAL to make a route accessible at every version including unversioned requests.

Controller-level, method-level, and version-neutral routes

Versioning annotation rules:

1
@Controller({ path, version }) sets the default version for all routes in the controller.
2
@Version() on a method overrides the controller-level version for that specific route.

How do you apply versioning at controller and method level in NestJS and how do you mark a route as version-neutral?

Difficulty: 5/10

controller versioning, method versioning, version-neutral routes

Apply @Controller({ path, version }) for controller-level versioning and @Version() on individual methods to override or add versions. Use @Version(['1', '2']) to handle multiple versions with one handler. Use VERSION_NEUTRAL to make a route accessible at every version including unversioned requests.

Controller-level, method-level, and version-neutral routes

Versioning annotation rules:

1
@Controller({ path, version }) sets the default version for all routes in the controller.
2
@Version() on a method overrides the controller-level version for that specific route.

How do you apply versioning at controller and method level in NestJS and how do you mark a route as version-neutral?

How do you apply versioning at controller and method level in NestJS and how do you mark a route as version-neutral?

Scenario Questions

Follow-up Questions