What is the best way to handle a global path parameter in a Nest.js application?

Question

What is the best way to handle a global path parameter in a Nest.js application?

Currently, I am in the process of constructing a rest API for a fully multi-tenant system using a single database and application. To achieve this, I have chosen NestJS as my framework of choice. My goal is to structure all modules based on the :tenantID that I provide at the root location of the application.

For instance, if I have modules such as users and conversations, I envision the endpoints to appear like this:

app_url/:tenantID/users app_url/:tenantID/conversations

Despite my efforts, I have not been able to find any guidance on how to implement this specific feature.

typescript nestjs

Answer 1

Answer №1

If you want to easily include the global parameter in all controllers' routes, you can do it like this:

app.controller.ts:

import { Controller, Get, Param } from '@nestjs/common';
import { AppService } from './app.service';

@Controller(':account')
export class AppController {
    constructor(private readonly appService: AppService) {}

    @Get()
    getHello(@Param('account') account: string): string {
        console.log(account)
        return this.appService.getHello();
    }
}

users.controller.ts:

import { Controller, Get, Param } from '@nestjs/common';

@Controller(':account/users')
export class UsersController {
    @Get()
    getUsers(@Param('account') account: string) {
        console.log(`Account ${account} has the following users:`);
        return true;
    }
}

Answer 2

If you want to easily include the global parameter in all controllers' routes, you can do it like this:

app.controller.ts:

import { Controller, Get, Param } from '@nestjs/common';
import { AppService } from './app.service';

@Controller(':account')
export class AppController {
    constructor(private readonly appService: AppService) {}

    @Get()
    getHello(@Param('account') account: string): string {
        console.log(account)
        return this.appService.getHello();
    }
}

users.controller.ts:

import { Controller, Get, Param } from '@nestjs/common';

@Controller(':account/users')
export class UsersController {
    @Get()
    getUsers(@Param('account') account: string) {
        console.log(`Account ${account} has the following users:`);
        return true;
    }
}

What is the best way to handle a global path parameter in a Nest.js application?

Answer №1

Similar questions

Exploring the functionality of this TypeScript code: What's the distinction between { [key: string]: string }[] and { prop1: string, prop2: string }[]

"Encountering Devextreme Reactive Errors while navigating on the main client

Tips for efficiently utilizing Hooks with React Context:

React form submissions are not saving the state

How to use ngModel directive in Angular to select/unselect dynamically generated checkboxes and retrieve their values

Encountering an error of undefined upon submission of a form while utilizing ng

Ensuring accurate properties are sent to popup notifications

The authService is facing dependency resolution issues with the jwtService, causing a roadblock in the application's functionality

Using TypeScript: Union Types for Enum Key Values

Angular 2, the change event is not triggering when a bootstrap checkbox is clicked

Encountering an issue with MUI Props: "Must provide 4 to 5 type arguments."

Display Material Popup in Angular before user leaves the page

Tips for implementing a multi-layered accumulation system with the reduce function

Organized modules within an NPM package

Utilizing React Typescript to Efficiently Manage Multiple Checkboxes within a List

Iterating through elements within the ng-content directive in Angular using *ngFor

Replace Formik with useFormik to streamline your code

Utilizing the backtick operator for string interpolation allows for dynamic value insertion

Expect a reply within the loop

The error message "Property '$store' is not defined on type 'ComponentPublicInstance' when using Vuex 4 with TypeScript" indicates that the property '$store' is not recognized