Skip to main content
The NestJS CRUD framework is a modular collection of packages that work together to provide powerful CRUD functionality for RESTful APIs built with NestJS.

​
Package Architecture

The framework is split into specialized packages, each serving a specific purpose:

@nestjsx/crud

Core package providing decorators and controllers

@nestjsx/crud-typeorm

TypeORM integration for database operations

@nestjsx/crud-request

Request query builder and parser

​
How They Work Together

The packages are designed to work together seamlessly:
  1. @nestjsx/crud - The foundation that provides the @Crud() decorator, base services, and controller generation
  2. @nestjsx/crud-typeorm - Extends the base service to provide TypeORM-specific CRUD operations
  3. @nestjsx/crud-request - Handles query string parsing and provides a query builder for frontend applications
You can use each package independently or combine them based on your needs. For a complete CRUD solution with TypeORM, you’ll typically use all three packages.

​
Key Features

Across all packages, you get:
  • Automatic CRUD endpoints - Generate standard REST endpoints with minimal code
  • Advanced query capabilities - Filtering, pagination, sorting, relations, and nested relations
  • Validation - Built-in query parameter and DTO validation
  • Flexibility - Easy to override and customize default behavior
  • Type safety - Full TypeScript support throughout
  • Swagger integration - Automatic API documentation generation

​
Version Information

All packages are currently at version 5.0.0-alpha.3 and are maintained under the @nestjsx namespace.

​
Next Steps

Quick Start

Get started with a simple CRUD example

Installation

Install and configure the packages