Response Decorators

Reusable decorators for common NestJS Swagger response schemas.

ts

import { ApiErrorResponses, ApiPaginatedResponse } from '@querry-kit/nest-util';

`ApiPaginatedResponse(options)`

ApiPaginatedResponse({ model, description?, links?, example?, examples? }) documents a response with items and meta properties.

ts

@ApiPaginatedResponse({ model: UserDto })
findMany() {}

`ApiErrorResponses(options?)`

ApiErrorResponses(options?) documents common error responses for status codes 400, 401, 403, 404, 409, 429, and optionally 500.

ts

@ApiErrorResponses({
  badRequestCodes: ['ValidationFailed'],
  notFoundDescription: 'User not found',
  internalServerError: true,
})
findOne() {}