nest-endpoints

nest-endpoints is a zero-config NestJS module that scans registered HTTP routes at bootstrap, keeps bounded in-memory request metrics, and exposes both a JSON API and a small embedded dashboard.

Install

npm install nest-endpoints

Peer dependencies:

• @nestjs/common
• @nestjs/core
• reflect-metadata
• rxjs

Usage

import { Module } from '@nestjs/common';
import { EndpointsModule } from 'nest-endpoints';

@Module({
  imports: [
    EndpointsModule.forRoot({
      path: '_endpoints',
      trackRequests: true,
      auth: {
        enabled: true,
        username: 'admin',
        password: 'secret'
      },
      exclude: ['/health', '/metrics']
    })
  ]
})
export class AppModule {}

By default the package exposes:

• GET /_endpoints
• GET /_endpoints/api/routes
• GET /_endpoints/api/routes/:id
• GET /_endpoints/api/stats
• GET /_endpoints/api/stats/:routeId
• GET /_endpoints/api/meta
• DELETE /_endpoints/api/stats

Config

export interface EndpointsConfig {
  path?: string;
  auth?: {
    enabled: boolean;
    username: string;
    password: string;
  };
  exclude?: string[];
  trackRequests?: boolean;
  maxRequestHistory?: number;
  globalPrefix?: string;
  ui?: {
    enabled?: boolean;
    theme?: 'light' | 'dark' | 'auto';
  };
}

Notes

• Route scanning runs in onApplicationBootstrap so third-party modules have time to register their controllers.
• Request history is stored in a fixed-size circular buffer per route.
• The dashboard routes are registered through the active HTTP adapter so the configured path can stay dynamic.
• When trackRequests is disabled, route scanning and the JSON API still work.