nestjsx/crud
Crud
This project is a REST API framework for NestJS designed to automate the creation of boilerplate-free CRUD endpoints and resource management. It functions as an automated CRUD generator that produces controllers and services for standard database operations, accelerating the development of RESTful APIs.
The toolkit includes a REST query parser that translates complex URL parameters into structured database filters, pagination, and sorting rules. It also operates as an API response serializer to control the exposure of entity fields and manage nested relations within JSON responses. For extended control, it provides a resource orchestrator for defining resource slugs and overriding standard endpoint behavior with custom handler functions.
The framework covers several core capability areas, including dynamic data filtering, resource response serialization, and the automation of API documentation. It also provides mechanisms for validating request data, assigning access control metadata, and filtering data based on user identity.
Features
- CRUD Interfaces - Automates the generation of CRUD interfaces for relational database records to eliminate boilerplate code.
- Automatic REST Endpoint Generators - Automatically derives RESTful API endpoints from backend data models and class definitions to eliminate boilerplate code.
- CRUD Operations - Automates the creation of standard endpoints for reading, writing, updating, and deleting database entities.
- Data Query Filters - Implements field-level conditions and logical operators to filter resource results via query parameters.
- Database Record Operations - Provides a standardized base service to perform create, read, update, and delete actions on relational databases.
- Query Sorting - Implements functionality for ordering returned data by one or multiple fields in ascending or descending sequence.
- Relational Join Mappers - Provides mechanisms to resolve nested relational data by performing database joins and mapping results to structured API responses.
- Decorator-Based - Uses TypeScript decorators to attach metadata to controllers, enabling the automatic mapping of requests to service operations.
- RESTful Resource Management - Implements a system for defining resource slugs and overriding standard endpoint behavior with custom handler functions.
- API Response Serializers - Transforms internal data structures into network-ready formats and excludes sensitive fields to control response exposure.
- Request Body Validations - Enforces data integrity on request bodies using data transfer objects and validation groups.
- CRUD API Implementations - Provides standardized implementations of create, read, update, and delete operations for web resources.
- CRUD Endpoint Exposure - Automates the creation of RESTful endpoints for standard database operations, including support for bulk creation.
- CRUD Generators - Generates controllers and services for standard database operations to accelerate RESTful API development.
- Dynamic Request Filterings - Implements advanced search, sorting, and pagination logic using structured request query parameters.
- Entity-Based Response Formatters - Transforms database entities into public API responses by mapping internal objects to specific attributes and excluding sensitive fields.
- Limit Offset Pagination - Controls the volume of returned data using limit and offset query parameters for result set navigation.
- NestJS Application Frameworks - Provides a toolkit for automating boilerplate-free CRUD endpoints and resource management within NestJS applications.
- Query Parameter Parsing - Translates raw URL query strings into structured internal objects for pagination, sorting, and relational joins.
- Request Schema Validators - Verifies that query parameters, path variables, and data objects meet defined schema requirements.
- REST API Query Parsers - Provides a logic engine that translates complex URL parameters into structured database filters, pagination, and sorting rules.
- RESTful API Development - Provides a framework for building standard web services by automating endpoints for data retrieval and modification.
- Field Selection - Allows specifying which entity fields to return in the response body to optimize network payload size.
- Fluent Query Builders - Provides a chainable interface for constructing structured request parameters that match backend filtering and sorting logic.
- API Documentation Generators - Automatically generates technical documentation for API endpoints based on defined controllers and entities.
- Base-Class Feature Inheritance - Implements a base service class to share common database CRUD logic across different resource services.
- Automated API Documentation - Automatically generates technical specifications for resource-based endpoints from controller and entity definitions.
- Data Access Filters - Restricts data access by automatically adding search conditions to queries based on authenticated user properties.
- API Documentation Generators - Automatically generates technical API specifications by reflecting on controllers and entity definitions.
- Server Frameworks - CRUD controller and service generator for NestJS and TypeORM.
