How itsshashanksp/generic_sql_api_framework works
Generic SQL REST API Framework: clients submit JSON actions to a shared API, which authenticates and authorizes requests, validates them, executes database operations, and returns a request-ID JSON response. The graph also preserves the separate Admin management plane, health checks, SQL-to-request parser, and application backup/recovery. Several subsystem links are documented by the README; source-level links use the sampled SOURCE INDEX or excerpts, so unsampled wiring is not inferred.
Main entry points: index.php JSON API entry · QueryRepository.php Query construction · Database.php Database connection · api.php Admin API
Components 25
API runtime
- JSON API entry
api/index.php - Authentication
app/Middleware/AuthenticationMiddleware.php - Role authorization
app/Services/AuthorizationService.php - Request validation
app/Requests/QueryRequestValidator.php - Query controller
app/Controllers/QueryController.php - JSON response envelope
core/Response.php
Data access
- Query service
app/Services/QueryService.php - Query construction
app/Repositories/QueryRepository.php - SQL execution
core/QueryEngine.php - Database connection
core/Database.php - Driver factory
database/factory/DriverFactory.php - Database metadata
app/Repositories/MetadataRepository.php - Generic CRUD
app/Services/WriteService.php - SQL Resources
app/Resources/SqlResourceDiscovery.php
Administration
- Admin API
admin/api.php - Admin Console
admin/index.php - Backup and recovery
app/Backup/BackupRecoveryService.php - Runtime configuration
app/Configuration/RuntimeConfiguration.php
Auxiliary services
- Health endpoints
api/health.php - SQL parser endpoint
sqlparser/index.php - Parser request handler
sqlparser/src/SqlParserRequestHandler.php - SQL-to-JSON parser
sqlparser/src/SqlParser.php
Other components
- Client application
- SQL database
- System administrator
Connections 25
- Client application → JSON API entry: submits JSON
README.md - JSON API entry → Authentication: runs middleware
api/index.php - JSON API entry → Request validation: validates requests
api/index.php - JSON API entry → Query controller: dispatches actions
api/index.php - Authentication → Role authorization: resolves principal
- Query controller → Query service: calls service
app/Controllers/QueryController.php - Query service → Query construction: delegates queries
app/Services/QueryService.php - Query construction → SQL execution: executes SQL
app/Repositories/QueryRepository.php - SQL execution → Database connection: uses connection
core/QueryEngine.php - Database connection → Driver factory: creates driver
core/Database.php - Database connection → SQL database: runs statements
README.md - Query construction → Database metadata: uses catalog
app/Repositories/QueryRepository.php - Client application → Generic CRUD: requests CRUD
README.md - Client application → Database metadata: requests metadata
README.md - Client application → SQL Resources: requests resource
README.md - System administrator → Admin API: manages system
README.md - System administrator → Admin Console: uses console
README.md - Admin API → Runtime configuration: controls settings
- Admin API → Backup and recovery: manages backups
- Client application → Health endpoints: checks health
README.md - Client application → SQL parser endpoint: submits SQL
README.md - SQL parser endpoint → Parser request handler: routes request
sqlparser/index.php - Parser request handler → SQL-to-JSON parser: parses SQL
- Parser request handler → JSON response envelope: emits JSON
sqlparser/src/SqlParserRequestHandler.php - JSON API entry → JSON response envelope: returns envelope
README.md