Skip to content
This repository has been archived by the owner on Oct 8, 2022. It is now read-only.

Tools to implement JSON API, such as endpoint, query params, body params, validation, and transformation response.

License

Notifications You must be signed in to change notification settings

ringcentral/nestjs-json-api

Repository files navigation

New version with support TypeOrm 3.x.x and NestJs 9.x.x here

NPM Version Package License NPM Downloads Commitizen friendly Coverage Badge

Json API plugin for NestJS framework

Tools to implement JSON API, such as, end point, query params, body params, validation and transformation response.

Description

This is the plugin that works upon TypeOrm library as a main database abstraction layer tool. Module automaticly generates API according to JSON API specificaton from the database structure (TypeORM entities). It support such features as requests validation based on database fields types, request filtering, endpoints exdending, data relations control and much more. Our module significantly reduces the development time of REST services by removing the need to negotiate the mechanism of client-server interaction and implementing automatic API generation without the need to write any code.

Installation

$ npm install
$ npm run typeorm:run
$ npm run db:seed

Running the app

# development
$ npm run start

# watch mode
$ ng serve

Test

# unit tests
$ nx affected:test

# test coverage
$ nx affected:test --coverage

License

The plugin is MIT licensed.

About

Tools to implement JSON API, such as endpoint, query params, body params, validation, and transformation response.

Resources

License

Stars

Watchers

Forks

Packages

No packages published