Install

npm i @nestjs-crud/core class-transformer class-validator

You also need ONE of the adapter packages: @nestjs-crud/typeorm, @nestjs-crud/drizzle, @nestjs-crud/mikro-orm, or @nestjs-crud/prisma.

Usage

@nestjs-crud/core provides the framework primitives:

• @Crud() decorator — class-level on a controller; auto-generates 8 RESTful routes (getMany, getOne, createOne, createMany, updateOne, replaceOne, deleteOne, recoverOne).
• @Override(), @ParsedRequest() — method/parameter decorators for customizing generated routes.
• CrudConfigService — global defaults for query parsing, response shape, validation groups.
• CrudCacheNotConfiguredError (new in v2.0.0) — thrown when @Crud({ query: { cache } }) is set without a wired CacheStrategy (and, for TypeORM, without a DataSource.cache fallback). Honored across all 4 adapters via the unified CacheStrategy interface in @nestjs-crud/core/cache (v2.2.0+).

import { Controller } from '@nestjs/common';
import { Crud, CrudController } from '@nestjs-crud/core';
import { TypeOrmCrudService } from '@nestjs-crud/typeorm';
import { Company } from './company.entity';

@Crud({ model: { type: Company } })
@Controller('companies')
export class CompaniesController implements CrudController<Company> {
  constructor(public service: TypeOrmCrudService<Company>) {}
}

See also

• Wiki: Controllers — full @Crud() options + Swagger + validation
• Wiki: Requests — query-string syntax
• Wiki: Services — adapter overview
• Wiki: Caching — cache wiring + CrudCacheNotConfiguredError
• v2 Migration guide