How to create and apply a prefix to a NestJS module and its child modules?

If you are working with NestJS, you may come across a situation where you need to create and apply a prefix to a module and its child modules. This can be useful when you want to organize your code and avoid naming conflicts between different modules. In this blog post, we will explore two solutions to achieve this.

Solution 1: Using the `GlobalPrefix` property

The first solution involves using the `GlobalPrefix` property provided by NestJS. This property allows you to specify a global prefix that will be applied to all routes defined within the module and its child modules.

To create a prefix for a module, you can simply set the `GlobalPrefix` property in the module’s decorator. Here’s an example:


  import { Module, Global } from '@nestjs/common';

  @Global()
  @Module({
    GlobalPrefix: 'api/v1',
    // other module configurations
  })
  export class AppModule {}

In the above example, we have set the global prefix to `’api/v1’`. This means that all routes defined within the `AppModule` and its child modules will have the prefix `’api/v1’`. For example, if you have a `UserController` with a route decorator `@Get(‘users’)`, the actual route will be `’api/v1/users’`.

Solution 2: Using the `forRoot()` method

The second solution involves using the `forRoot()` method provided by NestJS. This method allows you to create a module with a prefix and return a configured module.

To create a module with a prefix, you can define a static method in your module class that returns a configured module with the desired prefix. Here’s an example:


  import { Module } from '@nestjs/common';

  @Module({})
  export class UserModule {
    static forRoot(prefix: string): DynamicModule {
      return {
        module: UserModule,
        providers: [UserService],
        controllers: [UserController],
        exports: [UserService],
        // other module configurations
      };
    }
  }

In the above example, we have defined a static method `forRoot()` in the `UserModule` class. This method takes a `prefix` parameter and returns a configured module with the specified prefix. You can then import this module in your `AppModule` and pass the desired prefix as an argument to the `forRoot()` method.


  import { Module } from '@nestjs/common';
  import { UserModule } from './user.module';

  @Module({
    imports: [UserModule.forRoot('api/v1')],
    // other module configurations
  })
  export class AppModule {}

In the above example, we have imported the `UserModule` and passed the prefix `’api/v1’` to the `forRoot()` method. This will create the `UserModule` with the prefix `’api/v1’`.

Conclusion

Creating and applying a prefix to a NestJS module and its child modules can be easily achieved using either the `GlobalPrefix` property or the `forRoot()` method. Both solutions provide a way to organize your code and avoid naming conflicts. Choose the solution that best fits your requirements and enjoy cleaner and more maintainable code!

How to create and apply a prefix to a NestJS module and its child modules?