NestJS CRUD controller generator

createCrudController(Service, options) is the NestJS CRUD generator for Drizzle in this package: it returns a controller class whose routes call your service. You get offset and cursor lists, get, create, update, delete, soft delete, restore, a trash list and four opt-in bulk routes. The id pipe follows the primary key column, so you stop copying the same controller for every table.

How do I generate a controller?Copy Anchor Link

Extend the class the factory returns and put @Controller on your subclass:

import { Controller } from '@nestjs/common';
import { createCrudController } from '@avytrix/nestjs-drizzle-crud';
import { CreateProjectDto } from './dto/create-project.dto';
import { UpdateProjectDto } from './dto/update-project.dto';
import { ProjectsService } from './projects.service';

@Controller('projects')
export class ProjectsController extends createCrudController(ProjectsService, {
  dto: { create: CreateProjectDto, update: UpdateProjectDto },
  deleteMode: 'soft',
  routes: { bulkCreate: true, bulkDelete: true },
}) {}

Import the DTOs as values, not with import type. The factory hands the classes to Nest, and a type-only import is erased at build time.

Which routes does it generate?Copy Anchor Link

Eight routes are on by default. The four bulk routes stay off until you turn them on.

A few rules hold across the table:

• Query strings. list and trash run the whole query string through parseQuery, so filters, sortBy, fields, with, counts, withCount and cursor all work. get, create, update, restore and the bulk writes read only ?with=, ?fields= and ?counts= and ignore the rest.
• Trash. On an entity without soft delete, trash, softDelete, restore and bulkRestore answer 404 with This resource has no trash. The trash route turns allowTrash off, so ?withDeleted= cannot widen it.
• Bulk bodies. ids must be a non-empty array and data must be an object. Anything else is a 400.
• Route order. The static paths (/trash, /bulk, /bulk-delete, /bulk-restore) are registered before /:id, so they never match as an id.

How is the id parsed?Copy Anchor Link

From the primary key column at request time, the way the matching Nest pipe would parse it:

The service exposes the same logic as service.parseId(raw) and service.idKind(), which you can call from your own controllers. Set idType: 'int' | 'uuid' | 'string' to fix the pipe when the class is built instead. It then shows on the route as a normal @Param('id', ParseIntPipe).

Which options does createCrudController take?Copy Anchor Link

Every option is optional. The source is crud-controller.factory.ts.

How do I validate request bodies?Copy Anchor Link

Pass the DTO classes in dto. They become the parameter types of create and update, so a global ValidationPipe validates them the usual way. bulkCreate validates each array element with ParseArrayPipe({ items: dto.create }).

app.useGlobalPipes(new ValidationPipe({ whitelist: true, transform: true }));

Without dto, bodies reach the service unvalidated. writableColumns still applies, so a body cannot write a column you did not allow.

How do I turn routes on or off?Copy Anchor Link

Set a route to true or false in routes. An object turns it on and carries decorators for that route alone:

@Controller('tags')
export class TagsController extends createCrudController(TagsService, {
  routes: {
    delete: false,                              // no DELETE /:id
    bulkDelete: true,                           // POST /bulk-delete
    update: { decorators: [Roles('admin')] },   // PATCH /:id, admins only
  },
}) {}

Roles stands for your own role decorator. { enabled: false } works the same as false.

How do I add guards, interceptors or Swagger tags?Copy Anchor Link

decorators applies method decorators to every route, before the per-route ones. classDecorators decorates the generated class. You can also decorate your subclass directly, which reads like any other Nest controller:

@ApiTags('projects')
@UseGuards(AuthGuard)
@Controller('projects')
export class ProjectsController extends createCrudController(ProjectsService, {
  decorators: [UseInterceptors(AuditInterceptor)],
}) {}

How do I document the routes in Swagger?Copy Anchor Link

Pass openapi. The factory applies ApiCrudList to list, and ApiCrudList(source, { trash: true }) to trash:

@Controller('projects')
export class ProjectsController extends createCrudController(ProjectsService, {
  openapi: { table: projects, ...projectsCrud },
}) {}

Keep the entity config in one constant (projectsCrud) and spread it into both forFeature and openapi. The docs then list the same filterable and sortable columns the service accepts.

Can I add my own routes?Copy Anchor Link

Yes. The factory returns a class, so extend it and add methods. The service is on this.service:

@Controller('projects')
export class ProjectsController extends createCrudController(ProjectsService) {
  @Get('stats/by-name')
  stats() {
    return this.service.countBy('name');
  }
}

To replace a generated route, turn it off in routes and declare your own handler for the same path. Do not override a generated method by name: the route metadata sits on the generated handler, so Nest would not route your override.

Common questionsCopy Anchor Link

Next stepsCopy Anchor Link