PHPackages hexcj/api-builder-laravel - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. hexcj/api-builder-laravel ActiveLibrary hexcj/api-builder-laravel ========================= A dynamic Laravel API endpoint builder driven by database configuration. 04↑2900%PHP Since Jul 27Pushed yesterdayCompare [ Source](https://github.com/HexCJ/api-builder-laravel)[ Packagist](https://packagist.org/packages/hexcj/api-builder-laravel)[ RSS](/packages/hexcj-api-builder-laravel/feed)WikiDiscussions main Synced today READMEChangelogDependenciesVersions (1)Used By (0) Laravel API Builder =================== [](#laravel-api-builder) Laravel API Builder is a reusable Laravel 10 package for creating REST endpoints from administrator-defined database configuration. It stores endpoint definitions in the database and builds runtime queries with Laravel Query Builder. Requirements ------------ [](#requirements) - PHP 8.1-8.3 - Laravel 10 - Database driver supported by Laravel Schema and Query Builder - `doctrine/dbal` for richer schema metadata Installation ------------ [](#installation) Install the package: ``` composer require hexcj/api-builder-laravel ``` For local path development: ``` { "repositories": [ { "type": "path", "url": "packages/laravel-api-builder" } ], "require": { "hexcj/api-builder-laravel": "*" } } ``` Publish configuration and migrations when customization is needed: ``` php artisan vendor:publish --tag=api-builder-config php artisan vendor:publish --tag=api-builder-migrations php artisan migrate ``` The package supports Laravel auto-discovery through `LaravelApiBuilder\Providers\ApiBuilderServiceProvider`. Configuration ------------- [](#configuration) `config/api-builder.php` controls route prefixes, middleware, metadata visibility, pagination limits, and whether raw expressions are allowed. Raw expressions are disabled by default: ``` 'security' => [ 'allow_raw_expressions' => false, 'max_limit' => 500, 'default_limit' => 50, ], ``` Enable raw expressions only for trusted administrators. Database -------- [](#database) The package creates `api_endpoints`: - `id` - `name` - `path` - `method` - `table_name` - `description` - `auth_required` - `active` - `configuration` - timestamps The configuration JSON shape is: ``` { "columns": [], "joins": [], "where": [], "with": [], "aggregations": [], "group_by": [], "having": [], "order_by": [], "computed": [], "aliases": [], "window": [], "pagination": {}, "distinct": false, "limit": null, "offset": null } ``` Admin UI -------- [](#admin-ui) Open: ``` /api-builder ``` The UI lets administrators create endpoints with: - Name - Path - Method - Table - Column selection loaded automatically from schema metadata - Joins, where filters, grouping, ordering, pagination, distinct, auth, active state - Direct JSON configuration for advanced features Saving an endpoint only writes database records. It does not generate PHP files. Runtime ------- [](#runtime) Dynamic runtime route: ``` /api/{dynamicEndpoint} ``` Example: ``` GET /api/users ``` Runtime flow: 1. Find endpoint by path and method. 2. Validate that it exists. 3. Validate that it is active. 4. Validate endpoint authentication requirement. 5. Validate table and column configuration. 6. Build a Laravel Query Builder instance. 7. Run the configured builder pipeline. 8. Execute and return JSON. Metadata API ------------ [](#metadata-api) ``` GET /api/builder/tables GET /api/builder/table/users ``` Responses include table names, columns, primary key, foreign keys, and indexes when supported by the database driver. Query Features -------------- [](#query-features) ### Select and Distinct [](#select-and-distinct) ``` { "columns": ["id", "name", "email"], "distinct": true } ``` ### Joins [](#joins) Supported join types: - `inner` - `left` - `right` - `cross` ``` { "joins": [ { "type": "left", "table": "roles", "first": "users.role_id", "operator": "=", "second": "roles.id" } ] } ``` ### With Subselects [](#with-subselects) `with` adds related scalar data through Laravel Query Builder subselects. ``` { "with": [ { "alias": "latest_order_total", "table": "orders", "column": "total", "where_column": [ { "first": "orders.user_id", "operator": "=", "second": "users.id" } ], "order_by": [ { "column": "orders.created_at", "direction": "desc" } ], "limit": 1 } ] } ``` ### Where [](#where) Supported operators: - `=` - `!=` - `` - `=` - `LIKE` - `NOT LIKE` - `BETWEEN` - `NOT BETWEEN` - `NULL` - `NOT NULL` - `IN` - `NOT IN` - `EXISTS` - `RAW` Nested AND/OR: ``` { "where": [ { "column": "active", "operator": "=", "value": true }, { "boolean": "or", "nested": [ { "column": "email", "operator": "LIKE", "value": "%@example.com" }, { "column": "created_at", "operator": ">=", "value": "2026-01-01" } ] } ] } ``` EXISTS subquery: ``` { "where": [ { "operator": "EXISTS", "table": "orders", "where": [ { "column": "orders.user_id", "operator": "=", "value": 1 } ] } ] } ``` ### Aggregations, Group By, Having [](#aggregations-group-by-having) ``` { "columns": ["role_id"], "aggregations": [ { "function": "count", "column": "id", "alias": "users_count" } ], "group_by": ["role_id"], "having": [ { "column": "users_count", "operator": ">", "value": 10 } ] } ``` ### Aliases [](#aliases) ``` { "aliases": [ { "column": "users.name", "alias": "user_name" } ] } ``` ### Computed Columns [](#computed-columns) Requires `allow_raw_expressions=true`. ``` { "computed": [ { "expression": "CONCAT(first_name, ' ', last_name)", "alias": "full_name" } ] } ``` ### Window Functions [](#window-functions) Requires `allow_raw_expressions=true`. ``` { "window": [ { "function": "row_number", "partition_by": ["role_id"], "order_by": [{ "column": "created_at", "direction": "desc" }], "alias": "row_num" } ] } ``` ### Order [](#order) ``` { "order_by": [ { "column": "created_at", "direction": "desc" }, { "column": "id", "direction": "asc" } ] } ``` ### Limit and Offset [](#limit-and-offset) ``` { "limit": 100, "offset": 200 } ``` ### Pagination [](#pagination) Supported types: - `paginate` - `simplePaginate` - `cursorPaginate` ``` { "pagination": { "enabled": true, "type": "paginate", "per_page": 25 } } ``` Authentication -------------- [](#authentication) Endpoints can be saved with `auth_required=true`. Runtime checks use Laravel's authenticated request user. Configure route middleware for Sanctum, Passport, or a custom middleware stack: ``` 'api_middleware' => ['api', 'auth:sanctum'], ``` For public endpoints, leave `auth_required=false`. OpenAPI ------- [](#openapi) Generated documentation: ``` GET /api/builder/swagger.json ``` The document is generated from active endpoint configuration. Architecture ------------ [](#architecture) - Controllers handle HTTP only. - DTOs carry validated endpoint data. - Repositories isolate persistence. - Services coordinate validation, metadata, permissions, runtime execution, and OpenAPI generation. - Builders isolate query concerns: - `SelectBuilder` - `DistinctBuilder` - `JoinBuilder` - `WithBuilder` - `WhereBuilder` - `AggregationBuilder` - `HavingBuilder` - `ComputedBuilder` - `AliasBuilder` - `WindowBuilder` - `OrderBuilder` - `PaginationBuilder` - No runtime PHP files are generated for endpoints. Example Usage ------------- [](#example-usage) Create an endpoint: - Name: `Active Users` - Path: `users/active` - Method: `GET` - Table: `users` - Configuration: ``` { "columns": ["id", "name", "email"], "joins": [], "where": [ { "column": "active", "operator": "=", "value": true } ], "with": [], "aggregations": [], "group_by": [], "having": [], "order_by": [ { "column": "created_at", "direction": "desc" } ], "computed": [], "aliases": [], "window": [], "pagination": { "enabled": true, "type": "paginate", "per_page": 25 }, "distinct": false, "limit": null, "offset": null } ``` Call: ``` GET /api/users/active ``` Testing Strategy ---------------- [](#testing-strategy) Recommended coverage: - Unit test each builder with SQLite and assert generated Query Builder bindings/results. - Feature test metadata endpoints against test migrations. - Feature test endpoint create/update validation. - Feature test dynamic route execution for active, inactive, missing, public, and authenticated endpoints. - Feature test OpenAPI generation from saved endpoint definitions. - Security tests for invalid identifiers, invalid operators, duplicate paths, missing tables, missing columns, and disabled raw expressions. Run package tests: ``` composer test ``` ### Health Score 22 — LowBetter than 21% of packages Maintenance65 Regular maintenance activity Popularity5 Limited adoption so far Community6 Small or concentrated contributor base Maturity11 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/115712393?v=4)[Jonathan](/maintainers/HexCJ)[@HexCJ](https://github.com/HexCJ) --- Top Contributors [![HexCJ](https://avatars.githubusercontent.com/u/115712393?v=4)](https://github.com/HexCJ "HexCJ (6 commits)") ### Embed Badge ![Health badge](/badges/hexcj-api-builder-laravel/health.svg) ``` [![Health](https://phpackages.com/badges/hexcj-api-builder-laravel/health.svg)](https://phpackages.com/packages/hexcj-api-builder-laravel) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)