mevdschee/php-crud-api
Php Crud Api
This project is a PHP SQL REST API generator and database API wrapper that automatically transforms SQL database tables into a functional web interface. It serves as a lightweight layer that maps HTTP methods to SQL commands, allowing for the creation, reading, updating, and deletion of records without writing manual endpoint code.
The tool distinguishes itself by providing a dedicated spatial data API gateway for querying and exporting geometry columns using GeoJSON and WKT standards. It also functions as a multi-tenant data API, capable of isolating records for different users through shared columns or separate SQL databases.
Broad capabilities include an interface layer for schema mapping and legacy data restructuring, alongside built-in support for data filtering, pagination, and the retrieval of related data via join paths. The system also supports batch operations, bearer-token authentication, and the ability to extend endpoints through custom controller classes.
The application is available as a single-file distribution and can be deployed via Docker.
Features
- Database-to-REST Interfaces - Automatically generates RESTful API endpoints directly from database schemas and table structures.
- HTTP-to-SQL Mappers - Translates incoming REST method calls directly into corresponding SQL queries to automate database operations.
- CRUD Operations - Implements standard operations for creating, reading, updating, and deleting records within a SQL database.
- Spatial Querying - Provides spatial querying capabilities to filter geometry columns using WKT and GeoJSON standards.
- Criteria-Based Record Filtering - Refines database record lists using string patterns, numeric comparisons, and criteria-based filters.
- Dynamic Query Generation - Constructs SQL statements at runtime based on URL parameters for filtering, sorting, and pagination.
- Record Updates - Implements the ability to modify existing SQL database records via RESTful web requests.
- Relational Record Fetching - Retrieves nested resources and associated records by specifying relationship paths in the request.
- Database-to-HTTP Wrappers - Provides a lightweight abstraction layer mapping database operations directly to HTTP request handlers.
- GeoJSON Exporters - Exports database geometry columns as standard GeoJSON features with bounding box filtering.
- Multi-Tenant Data Management - Provides a structural system for managing and isolating multi-tenant data at the database level.
- Related Object Retrievers - Provides mechanisms for fetching associated database records to produce nested objects based on relations.
- Relational Join Engines - Combines data from multiple tables based on shared columns using filters passed via URL parameters.
- Relational Join Mappers - Retrieves nested related data by parsing specific join paths in the request to automate SQL joins.
- Spatial Data APIs - Provides a dedicated gateway for querying and exporting SQL geometry columns using GeoJSON and WKT.
- Multi-Tenant API Gateways - Provides an API gateway that uses tenant identifiers to isolate data and configuration access.
- Database REST APIs - Provides automatically generated RESTful endpoints that grant programmatic access to database records.
- Spatial Geometry Types - Handles spatial data by representing and filtering geometry columns using WKT and GeoJSON standards.
- Multi-Tenant Data Isolation - Isolates user data using either dedicated database connections or shared tables filtered by tenant identifiers.
- Schema Abstraction Layers - Decouples external API field names from internal database column names through a configurable mapping layer.
- Dynamic REST API Generators - Translates database operations into RESTful endpoints at runtime without manual coding.
- API Gateways - Acts as an entry point that routes requests and generates secure endpoints from the underlying spatial database.
- API Pagination and Sorting - Controls the number of records returned per page and defines the sort order of results.
- Database Atomic Batches - Groups multiple database mutations into a single atomic operation using transactions to ensure consistency.
- Database Schema Mapping - Maps internal database tables and columns to clean, external API endpoints.
- Full Text Search - Implements global wildcard searching across text fields in SQL tables.
- JSON API Servers - Exposes database contents through a structured JSON interface for programmatic access.
- Rapid Prototyping Tools - Accelerates backend development by generating APIs directly from database schema definitions.
- Result Ordering and Limiting - Limits the number of returned records and defines the sort order of the results for large datasets.
- Schema Mapping Layers - Rename database tables and columns to create a clean interface for legacy data structures.
- Search Result Filtering - Provides mechanisms to apply constraints and filters to database results via API parameters.
- Field Alias Mapping - Provides field alias mapping to decouple external API field names from internal database column names.
- Column and Table Access Restrictions - Controls access to specific database tables, columns, or records via custom handler functions.
- Bearer Token Authentication - Provides secure data access by validating bearer tokens passed in HTTP request headers.
- Request Access Restrictions - Validates bearer tokens in HTTP headers to authorize requests and restrict API access.
- Input Validation & Sanitization - Enforces type rules and validation logic to sanitize input before it is stored in the database.
- Request Authentications - Secures API access by verifying user identity via bearer tokens in HTTP request headers.
- Server Capability Extenders - Supports adding specialized server-side logic by registering custom controllers into the routing system.
- Custom API Endpoints - Allows the extension of the API surface area by implementing custom controller classes for new routes.
