Skip to content

A robust framework for building data-driven APIs with a focus on CRUD operations. Interface Data API extends the core API interface with specialized functionality for handling database records, making it simple to create RESTful endpoints for your data models.

License

Notifications You must be signed in to change notification settings

AntelopeJS/interface-data-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Data API

Interface Data API

License Discord Documentation

A robust framework for building data-driven APIs with a focus on CRUD operations. Interface Data API extends the core API interface with specialized functionality for handling database records, making it simple to create RESTful endpoints for your data models.

Installation

ajs module imports add data-api@beta

Documentation

Detailed documentation is available in the docs directory:

  • Introduction - Overview and basic concepts
  • Data Controllers - Creating and using Data API controllers
  • Routes - Defining routes and endpoints
  • Access Rights - Managing read and write access of objects fields
  • Validation - Validating requests data data before processing
  • Listing - Retrieving lists of records with pagination
  • Foreign Keys - Handling foreign key relationships in data models
  • Filters - Applying filters to data queries

Current Status

This is the development version (beta) of the Interface Data API. It is currently in pre-release stage and may undergo changes before the final release. The interface is not considered stable for production use without understanding that breaking changes may occur.

Versions

Version Link Status
beta data-api@beta Waiting validation from community to go in v1
1 Not yet released Planned stable release

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

About

A robust framework for building data-driven APIs with a focus on CRUD operations. Interface Data API extends the core API interface with specialized functionality for handling database records, making it simple to create RESTful endpoints for your data models.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published