CRUD

for RESTful APIs built with NestJs

Built with 💜 by @MichaelYali and Contributors

🌟 👀 ⚡ 💥

We believe that everyone who's working with NestJs and building some RESTful services and especially some CRUD functionality will find @nestjsx/crud microframework very useful.

Features

• 🔌 Super easy to install and start using the full-featured controllers and services 👉

• 🐙 DB and service agnostic extendable CRUD controllers

• 🔎 Reach query parsing with filtering, pagination, sorting, relations, nested relations, cache, etc.

• 🔭 Framework agnostic package with query builder for a frontend usage

• 👾 Query, path params and DTOs validation included

• 🎬 Overriding controller methods with ease

• 🔧 Tiny config (including globally)

• 🎁 Additional helper decorators

• ✏️ Swagger documentation

Packages

• @nestjsx/crud - core package which provides @Crud() decorator for endpoints generation, global configuration, validation, helper decorators (docs)
• @nestjsx/crud-typeorm - TypeORM package which provides base TypeOrmCrudService with methods for CRUD database operations (docs)
• @nestjsx/crud-request - request builder/parser package wich provides RequestQueryBuilder class for a frontend usage and RequestQueryParser that is being used internaly for handling and validating query/path params on a backend side (docs)

Documentation

Use Wiki

Roadmap

• TypeORM
• Mongoose
• Sequelize
• JSON API standard

Support

Any support is wellcome.

Contribution

Please open an issue or submit a PR if you want to improve the functionality or help with testing edge cases.

Sponsorship

Tests

docker-compose up -d
yarn bootstrap
yarn test

License

MIT