> ## Documentation Index
> Fetch the complete documentation index at: https://nestjs-query.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> The  package creates documented REST CRUD controllers on top of a . It provides DTO decorators, generated controllers, filtering, offset paging, hooks, authorization, and CSV export.

## Installation[​](#installation "Direct link to Installation")

See the [installation guide](/introduction/install#ptc-orgnestjs-query-rest).

This example uses the TypeORM adapter, so install it and TypeORM alongside the REST package (plus the TypeORM driver for your database):

```bash theme={null}
npm i @ptc-org/nestjs-query-typeorm @nestjs/typeorm typeorm
```

## Define the DTOs[​](#define-the-dtos "Direct link to Define the DTOs")

The response DTO declares the fields returned by the API and which fields clients may filter on. Separate create and update DTOs keep writable fields explicit.

todo-item.dto.ts

```ts theme={null}
import { FilterableField, IDField } from '@ptc-org/nestjs-query-rest'

export class TodoItemDTO {

  @IDField()
  id!: number

  @FilterableField()
  title!: string

  @FilterableField()
  completed!: boolean
}
```

todo-item-input.dto.ts

```ts theme={null}
import { Field } from '@ptc-org/nestjs-query-rest'

export class TodoItemInputDTO {

  @Field({ maxLength: 100 })
  title!: string

  @Field()
  completed!: boolean
}
```

todo-item-update.dto.ts

```ts theme={null}
import { Field } from '@ptc-org/nestjs-query-rest'

export class TodoItemUpdateDTO {

  @Field({ nullable: true, maxLength: 100 })
  title?: string

  @Field({ nullable: true })
  completed?: boolean
}
```

## Register an endpoint[​](#register-an-endpoint "Direct link to Register an endpoint")

Register the persistence module and describe the endpoint in `NestjsQueryRestModule.forFeature`. `basePath` is optional; without it, the path is derived from and pluralized from the DTO class name (`TodoItemDTO` becomes `/todo-item-dtos`).

todo-item.module.ts

```ts theme={null}
import { Module } from '@nestjs/common'
import { NestjsQueryRestModule } from '@ptc-org/nestjs-query-rest'
import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm'
import { TodoItemDTO } from './dto/todo-item.dto'
import { TodoItemInputDTO } from './dto/todo-item-input.dto'
import { TodoItemUpdateDTO } from './dto/todo-item-update.dto'
import { TodoItemEntity } from './todo-item.entity'

@Module({
  imports: [
    NestjsQueryRestModule.forFeature({
      imports: [NestjsQueryTypeOrmModule.forFeature([TodoItemEntity])],
      endpoints: [
        {
          DTOClass: TodoItemDTO,
          EntityClass: TodoItemEntity,
          CreateDTOClass: TodoItemInputDTO,
          UpdateDTOClass: TodoItemUpdateDTO,
          basePath: 'todo-items'
        }
      ]
    })
  ]
})
export class TodoItemModule {}
```

This creates the following endpoints:

| Method   | Path                 | Description                    |
| -------- | -------------------- | ------------------------------ |
| `GET`    | `/todo-items`        | Filter and page records        |
| `GET`    | `/todo-items/:id`    | Find one record                |
| `POST`   | `/todo-items`        | Create one record              |
| `PUT`    | `/todo-items/:id`    | Update one record              |
| `DELETE` | `/todo-items/:id`    | Delete one record              |
| `GET`    | `/todo-items/export` | Export matching records as CSV |

## Enable request transformation and validation[​](#enable-request-transformation-and-validation "Direct link to Enable request transformation and validation")

The generated query and body DTOs use `class-transformer` and `class-validator`. Enable Nest's `ValidationPipe` so query strings such as `limit=10` are converted and validated.

main.ts

```ts theme={null}
import { ValidationPipe } from '@nestjs/common'
import { NestFactory } from '@nestjs/core'
import { AppModule } from './app.module'

async function bootstrap() {
  const app = await NestFactory.create(AppModule)
  app.useGlobalPipes(
    new ValidationPipe({
      transform: true,
      whitelist: true
    })
  )
  await app.listen(3000)
}
void bootstrap()
```

Continue with [DTOs](/rest/dtos), [controllers](/rest/controllers), or the [query endpoint examples](/rest/queries/endpoints).

[Edit this page](https://github.com/tripss/nestjs-query/edit/master/docs/rest/getting-started)