typescript 38 lines · 6 steps

A reusable paginated Swagger decorator in NestJS

A generic factory that bundles Swagger decorators to document any paginated endpoint from a single model type.

Explained by highlit

NestJS Intermediate decorators generics openapi code-reuse pagination

1import { Type, applyDecorators } from '@nestjs/common';
2import {
ApiExtraModels,
ApiOkResponse,
ApiQuery,
getSchemaPath,
7} from '@nestjs/swagger';
8 
9export class PaginationMetaDto {
page: number;
limit: number;
totalItems: number;
totalPages: number;
14}
15 
16export const ApiPaginatedResponse = <TModel extends Type<unknown>>(
model: TModel,
description?: string,
19) =>
applyDecorators(
  ApiExtraModels(PaginationMetaDto, model),
  ApiQuery({ name: 'page', required: false, type: Number, example: 1 }),
  ApiQuery({ name: 'limit', required: false, type: Number, example: 20 }),
  ApiOkResponse({
    description: description ?? `Paginated list of ${model.name}`,
    schema: {
      type: 'object',
      required: ['data', 'meta'],
      properties: {
        data: {
          type: 'array',
          items: { $ref: getSchemaPath(model) },
        },
        meta: { $ref: getSchemaPath(PaginationMetaDto) },
      },
    },
  }),
);

01 / 01

STEP 01

Walkthrough

Space play ←→ step click any line

Three takeaways

1applyDecorators lets you compose several decorators into one reusable unit.
2A generic decorator factory adapts Swagger docs to any model type without repetition.
3getSchemaPath with ApiExtraModels wires up $ref schemas so nested DTOs render correctly.

Related explainers

typescript

import { registerLocaleData } from '@angular/common';
import localeFr from '@angular/common/locales/fr';
import localeFrExtra from '@angular/common/locales/extra/fr';
import localeDe from '@angular/common/locales/de';

Locale-aware bootstrapping in Angular

i18n localization dependency-injection

Intermediate 8 steps

typescript

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import * as Joi from 'joi';

Validating env config at boot in NestJS

configuration schema-validation environment-variables

Intermediate 8 steps

typescript

import { Inject, Injectable, Logger } from '@nestjs/common';
import { CACHE_MANAGER } from '@nestjs/cache-manager';
import { Cache } from 'cache-manager';
import { InjectRepository } from '@nestjs/typeorm';

A cache-aside country lookup in NestJS

cache-aside dependency-injection batch-lookup

Intermediate 8 steps

typescript

import { Injectable, effect, signal, computed } from '@angular/core';
 
interface Preferences {
  theme: 'light' | 'dark';

A signal-based preferences store in Angular

signals state-management persistence

Intermediate 7 steps

typescript

import { useEffect, useState } from "react";
 
interface Section {
  id: string;

Building a scroll-spy hook in React

custom-hooks intersectionobserver dom-observation

Intermediate 8 steps

typescript

import { Injectable, Scope, Inject, NotFoundException } from '@nestjs/common';
import { REQUEST } from '@nestjs/core';
import { Request } from 'express';
import { DataSource } from 'typeorm';