nestjs-rest

library1.0.0jsnpmunverified

Provides a base controller class for building RESTful APIs following the JSON:API specification within the NestJS framework. Current stable version is 1.0.0, released with a cadence of major versions matching NestJS updates. It requires @nestjs/common >=11.0.0 and std-json-api. The package is designed to be used with extension packages like nestjs-rest-mongodb for database integration. Key differentiators: adheres strictly to JSON:API spec, integrates seamlessly with NestJS decorators and providers, and supports dependency injection for configuration via JsonApiControllersOptions token.

devops

npm install nestjs-rest

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NESTJS-REST

nestjs-rest

devopsjavascriptv1.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

JsonApiController

✓ import { JsonApiController } from 'nestjs-rest'

✗ import JsonApiController from 'nestjs-rest'

Named export, not default. ESM-only.

JsonApiControllersOptions

✓ import { JsonApiControllersOptions } from 'nestjs-rest'

✗ import { JsonApiControllersOptions } from 'nestjs-rest'

Class used for dependency injection token.

NESTJS_REST_MODULE_ID

✓ import { NESTJS_REST_MODULE_ID } from 'nestjs-rest'

✗ const { NESTJS_REST_MODULE_ID } = require('nestjs-rest')

ESM-only, CJS require is not supported.

Shows how to create a basic JSON:API controller by extending JsonApiController and applying the @Controller decorator.

import { Controller } from '@nestjs/common'; import { JsonApiController } from 'nestjs-rest'; @Controller('api') export class MyController extends JsonApiController { // Add your own methods or override base ones }

Debug

Known issues

gotchaThe package requires Node >=20.0.0 and npm >=10.0.0.

fix

Ensure your environment meets the engine requirements.

affects: >=1.0.0

gotchaMust be used with an extension package (e.g., nestjs-rest-mongodb) for actual database integration.

fix

Install an extension package alongside nestjs-rest.

affects: >=1.0.0

breakingRequires @nestjs/common version >=11.0.0.

fix

Update @nestjs/common to at least version 11.

affects: >=1.0.0

gotchaJsonApiControllersOptions must be provided via a custom provider factory, not directly instantiated.

fix

Use the provider pattern shown in the documentation.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'std-json-api'

Missing peer dependency std-json-api.

fix

Run npm install std-json-api

Class extends value undefined is not a constructor or null

JsonApiController not imported correctly (likely default import used).

fix

Use named import: import { JsonApiController } from 'nestjs-rest'

Nest cannot resolve dependencies of JsonApiControllersOptions

JsonApiControllersOptions not provided properly or missing provider.

fix

Add a provider for JsonApiControllersOptions using a factory.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

@nestjs/commonrequiredPeer dependency required for NestJS decorators and base classes

std-json-apirequiredPeer dependency providing JSON:API serialization/deserialization utilities

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/ziv/nestjs-rest ↗

packagenestjs-rest ↗

homepagehttps://github.com/ziv/nestjs-rest#readme ↗