This is a Typescript library that provides a NestJS decorator which automatically generates CRUD routes of a controller for given TypeORM entity. The decorator generates endpoints for not only create, retrieve one, retrieve many, update, delete but also upsert, recover and search operations for the entity.
Features
Automatically generates CRUD routes for a given TypeORM entity
Automatically generates swagger for generated routes
In order to use the Crud decorator, you need to define a TypeORM entity first. The following example defines a User entity with the following properties.
import { BaseEntity, Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
@Entity()
export class User extends BaseEntity {
@PrimaryGeneratedColumn()
id: number;
@Column()
username: string;
@Column()
email: string;
}
Step 2: Create Service and Controller
Create a NestJS service and controller with a TypeORM entity. The service needs to extend the CrudService class and the controller needs to implement the CrudController interface.
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { CrudService } from '@nestjs-library/crud';
import { Repository } from 'typeorm';
import { User } from './user.entity';
@Injectable()
export class UserService extends CrudService<User> {
constructor(@InjectRepository(User) repository: Repository<User>) {
super(repository);
}
}
import { Controller } from '@nestjs/common';
import { Crud, CrudController } from '@nestjs-library/crud';
import { User } from './user.entity';
import { UserService } from './user.service';
@Crud({ entity: User })
@Controller('users')
export class UserController implements CrudController<User> {
constructor(public readonly crudService: UserService) {}
}
Step 3: Add Service, Controller and TypeORM module to your module
In your NestJS module, add Service, Controller and TypeORM module to providers, controllers, imports array respectively.
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './user.entity';
import { UserController } from './user.controller';
import { UserService } from './user.service';
@Module({
imports: [TypeOrmModule.forFeature([User])],
controllers: [UserController],
providers: [UserService],
})
export class UserModule {}
Step 4: Access the generated endpoints
After the module initializes, it will generate the following CRUD endpoints:
GET /users - retrieves a list of users with pagination
GET /users/:id - retrieves a single user by ID
POST /users - creates single or multiple users
PATCH /users/:id - updates an existing user by ID
DELETE /users/:id - deletes an existing user by ID
PUT /users/:id - upserts (update or create) an existing user by ID
POST /users/search - retrieves a list of users based on complex search criteria
POST /users/:id/recover - recovers a soft deleted user by ID
Configuration
The Crud decorator supports the following configuration options:
entity
(required) The TypeORM entity that the controller operates on.
routes
(optional) You can configure each route by specifying the routes option.
For example, if you want to set the default pagination size for a search route, you can specify option as below.
