# @nestjs-library/crud > Automatically generate CRUD Rest API based on NestJS and TypeOrm Latest version **0.13.1** (published 2025-05-16) · MIT license · 0 weekly downloads ## Install ```sh npm install @nestjs-library/crud pnpm add @nestjs-library/crud yarn add @nestjs-library/crud bun add @nestjs-library/crud ``` ## Health **Score 50/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads; pre 1.0. Negative: stale. ## Facts | | | |---|---| | Version | 0.13.1 | | Published | 2025-05-16 | | First published | 2023-02-02 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 14 | | Unpacked size | 484.2 KB | | Known vulnerabilities | 0 (+5 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 227 | | Maintainers | donghyuk | | Keywords | NestJS, CRUD, TypeORM, REST API, Swagger, Decorator | ## Links - npm: https://www.npmjs.com/package/@nestjs-library/crud - Repository: https://github.com/woowabros/nestjs-library-crud - Issues: https://github.com/woowabros/nestjs-library-crud/issues - npm.io page: https://npm.io/package/@nestjs-library/crud ## Dependencies (14) - [qs](https://npm.io/package/qs.md) 6.13.0 - [rxjs](https://npm.io/package/rxjs.md) ^7.8.1 - [tslib](https://npm.io/package/tslib.md) ^2.6.2 - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [express](https://npm.io/package/express.md) ^4.18.2 - [typeorm](https://npm.io/package/typeorm.md) ^0.3.17 - [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^11.0.11 - [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^11.0.11 - [@nestjs/swagger](https://npm.io/package/@nestjs/swagger.md) ^7.1.17 - [@nestjs/typeorm](https://npm.io/package/@nestjs/typeorm.md) ^10.0.1 - [class-validator](https://npm.io/package/class-validator.md) ^0.14.0 - [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.2.1 - [class-transformer](https://npm.io/package/class-transformer.md) ^0.5.1 - [@nestjs/platform-express](https://npm.io/package/@nestjs/platform-express.md) ^11.0.11 ## Alternatives - [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads - [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads - [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads - [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads - [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads ## Recent versions - 0.13.1 (latest) — 2025-05-16 - 0.6.0 (next) — 2023-07-13 - 0.13.0 — 2025-04-19 - 0.12.9 — 2024-08-29 - 0.12.8 — 2024-07-17 - 0.12.7 — 2024-06-17 - 0.12.6 — 2024-06-04 - 0.12.5 — 2024-06-04 - 0.12.4 — 2024-06-01 - 0.12.3 — 2024-05-27 - 0.12.2 — 2024-05-19 - 0.12.1 — 2024-05-12 - 0.12.0 — 2024-03-11 - 0.11.1 — 2024-03-04 - 0.11.0 — 2024-02-11 - … 47 more at https://npm.io/package/@nestjs-library/crud/versions ## README # @nestjs-library/crud

Node.js CI Coverage Status

English | 한국어

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 - Supports pagination, sorting, filtering, relation, searching, upserting, recovering and soft deleting - Supports complex search criteria(`LIKE`, `ILIKE`, `BETWEEN`, `IN`, `NULL`, `?`, `@>`, `JSON_CONTAINS`) - Supports strong validation by using [class-validator](https://github.com/typestack/class-validator) - Supports saving author information for mutating operations(Create, Update, Upsert, Delete and Recover) - Supports adding decorators, interceptors to each routes in Controller for customizing - Supports customizing swagger response ## Installation ```bash # npm npm install @nestjs-library/crud # yarn yarn add @nestjs-library/crud # pnpm pnpm add @nestjs-library/crud ``` ## Usage ### Step 1: Define a TypeORM entity 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. ```typescript 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. ```typescript 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 { constructor(@InjectRepository(User) repository: Repository) { super(repository); } } ``` ```typescript 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 { 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. ```typescript 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. ```typescript @Crud({ entity: User, routes: { search: { numberOfTake: 5 }, }, }) ``` Every route has the following base options. ```typescript import { NestInterceptor, Type } from '@nestjs/common'; interface RouteBaseOption { decorators?: Array; interceptors?: Array>; swagger?: { hide?: boolean; response?: Type; }; exclude?: string[]; } ``` `CREATE`, `UPDATE`, `DELETE`, `UPSERT`, and `RECOVER` routes can have the following options. ```typescript interface SaveOptions { listeners?: boolean; } ``` And each route has its own options as below. #### `READ_ONE` ```typescript interface ReadOneOptions { params?: string[]; softDelete?: boolean; relations?: false | string[]; } ``` #### `READ_MANY` ```typescript import { Sort, PaginationType } from 'src/lib/interface'; interface ReadManyOptions { sort?: Sort | `${Sort}`; paginationType?: PaginationType | `${PaginationType}`; numberOfTake?: number; relations?: false | string[]; softDelete?: boolean; paginationKeys?: string[]; } ``` #### `SEARCH` ```typescript import { PaginationType } from 'src/lib/interface'; interface SearchOptions { paginationType?: PaginationType | `${PaginationType}`; numberOfTake?: number; limitOfTake?: number; relations?: false | string[]; softDelete?: boolean; paginationKeys?: string[]; } ``` #### `CREATE` ```typescript import { Type } from '@nestjs/common'; import { Author } from 'src/lib/interface'; interface CreateOptions { swagger?: { body?: Type; }; author?: Author; } ``` #### `UPDATE` ```typescript import { Type } from '@nestjs/common'; import { Author } from 'src/lib/interface'; interface UpdateOptions { params?: string[]; swagger?: { body?: Type; }; author?: Author; } ``` #### `DELETE` ```typescript import { Author } from 'src/lib/interface'; interface DeleteOptions { params?: string[]; softDelete?: boolean; author?: Author; } ``` #### `UPSERT` ```typescript interface UpsertOptions { params?: string[]; swagger?: { body?: Type; }; author?: Author; } ``` #### `RECOVER` ```typescript interface RecoverOptions { params?: string[]; author?: Author; } ``` ### only (optional) An array of methods to generate routes for. If not specified, all routes will be generated. For example, if you want to generate only create and retrieve one, you can specify the following configuration. ```typescript import { Crud, Method } from '@nestjs-library/crud'; @Crud({ entity: User, only: [Method.CREATE, Method.READ_ONE] }) ``` ## [Contributors](https://github.com/woowabros/nestjs-library-crud/graphs/contributors) ![Contributors](https://contrib.rocks/image?repo=woowabros/nestjs-library-crud) ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=woowabros/nestjs-library-crud&type=Date)](https://star-history.com/#woowabros/nestjs-library-crud&Date) ## License This library is licensed under the MIT License. See the [LICENSE](./LICENSE.md) file for details. --- _Source: https://npm.io/package/@nestjs-library/crud · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._