A declarative framework for building data-driven REST APIs with automatic CRUD operations. Interface Data API connects your database models to API endpoints with built-in validation, access control, foreign key resolution, and pagination.
npm install @antelopejs/interface-data-apiDetailed documentation is available in the docs directory:
- Introduction - Overview, key features, and quick start
- Data Controllers - Create and configure data controllers
- Routes - Default routes, custom routes, and route options
- Access Rights - Control field read/write permissions with per-action overrides
- Validators - Field-level validation and mandatory fields
- Listable Fields - Pagination, pluck modes, and sorting
- Foreign Keys - Establish relationships between tables
- Filters - Add filtering capabilities to list endpoints
- Modifiers - Automatic data transformation with database-decorators
- Joined Fields - Flatten a remote field onto rows for native sort/filter
- Computed Fields - In-database computed values, sortable and pageable natively
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.