Route Parameters та Query Parameters

GET /users/42

id === '42'

@Get('posts/:postId/comments/:commentId')
findComment(@Param() params: { postId: string; commentId: string }) {
  return {
    postId: params.postId,
    commentId: params.commentId,
  };
}

GET /users/posts/10/comments/25

{
  postId: '10',
  commentId: '25'
}

/users?role=admin&limit=10

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

@Controller('users')
export class UsersController {
  @Get()
  findAll(
    @Query('role') role?: string,
    @Query('limit') limit?: string,
  ) {
    return {
      role,
      limit,
    };
  }
}

GET /users?role=admin&limit=10

{
  "role": "admin",
  "limit": "10"
}

@Query('limit') limit: number

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

@Controller('users')
export class UsersController {
  @Get()
  findAll(
    @Query('role') role: string | undefined,
    @Query('limit', new DefaultValuePipe(10), ParseIntPipe) limit: number,
  ) {
    return {
      role: role ?? null,
      limit,
      limitType: typeof limit,
    };
  }

  @Get(':id')
  findOne(@Param('id', ParseIntPipe) id: number) {
    return {
      id,
      idType: typeof id,
    };
  }
}

GET /users?role=admin&limit=20

{
  "role": "admin",
  "limit": 20,
  "limitType": "number"
}

GET /users/42

{
  "id": 42,
  "idType": "number"
}

GET /users/abc

@Query('limit', new DefaultValuePipe(10), ParseIntPipe)
limit: number

GET /users

{
  "role": null,
  "limit": 10,
  "limitType": "number"
}

import {
  Controller,
  DefaultValuePipe,
  Get,
  Param,
  ParseBoolPipe,
  ParseIntPipe,
  Query,
} from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Get()
  findAll(
    @Query('role') role: string | undefined,
    @Query('limit', new DefaultValuePipe(10), ParseIntPipe) limit: number,
    @Query('active', new DefaultValuePipe(true), ParseBoolPipe) active: boolean,
  ) {
    return {
      filters: {
        role: role ?? null,
        limit,
        active,
      },
    };
  }

  @Get(':id')
  findOne(
    @Param('id', ParseIntPipe) id: number,
    @Query('details') details: string | undefined,
  ) {
    return {
      id,
      details: details ?? null,
    };
  }
}

GET /users

{
  "filters": {
    "role": null,
    "limit": 10,
    "active": true
  }
}

GET /users?role=admin&limit=5&active=false

{
  "filters": {
    "role": "admin",
    "limit": 5,
    "active": false
  }
}

GET /users/15?details=full

{
  "id": 15,
  "details": "full"
}

/users/15

/users?role=admin&limit=10

@Get(':id')
findOne(
  @Param('id', ParseIntPipe) id: number,
  @Query('details') details?: string,
) {
  return { id, details };
}

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

type UsersQuery = {
  role?: string;
  sort?: string;
  limit?: string;
};

@Controller('users')
export class UsersController {
  @Get()
  findAll(@Query() query: UsersQuery) {
    return {
      role: query.role ?? null,
      sort: query.sort ?? null,
      limit: query.limit ?? null,
    };
  }
}

/users?role=admin&sort=name&limit=20

{
  role: 'admin',
  sort: 'name',
  limit: '20'
}

@Get()
findAll(
  @Query('role') role: string | undefined,
  @Query('limit', new DefaultValuePipe(10), ParseIntPipe) limit: number,
) {
  return { role, limit };
}

import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';

@Module({
  controllers: [UsersController],
})
export class AppModule {}

GET /users/7
GET /users?role=admin
GET /users?limit=25
GET /users/7?details=full

@Get(':id')
findOne(@Param('id') id: number) {
  return id + 1;
}

@Get(':id')
findOne(@Param('id', ParseIntPipe) id: number) {
  return id + 1;
}

@Get(':userId')
findOne(@Param('id') id: string) {
  return id;
}

@Get(':userId')
findOne(@Param('userId') userId: string) {
  return userId;
}

GET /users

@Get()
findAll(@Query('role') role?: string) {
  return {
    role: role ?? 'all',
  };
}

@Get()
findAll(
  @Query('limit', ParseIntPipe) limit: number,
) {
  return { limit };
}