PHPackages byjg/resttemplate - 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. [Database & ORM](/categories/database) 4. / 5. byjg/resttemplate Abandoned โ†’ [byjg/rest-reference-architecture](/?search=byjg%2Frest-reference-architecture)Library[Database & ORM](/categories/database) byjg/resttemplate ================= Production-ready PHP REST API boilerplate that lets you focus on building your business logic, not the infrastructure. 6.1(2mo ago)171137[1 issues](https://github.com/byjg/php-rest-reference-architecture/issues)MITPHPPHP >=8.3 <8.6CI failing Since Nov 22Pushed 2mo ago2 watchersCompare [ Source](https://github.com/byjg/php-rest-reference-architecture)[ Packagist](https://packagist.org/packages/byjg/resttemplate)[ RSS](/packages/byjg-resttemplate/feed)WikiDiscussions master Synced 3d ago READMEChangelog (4)Dependencies (14)Versions (12)Used By (0) PHP REST Reference Architecture =============================== [](#php-rest-reference-architecture) [![Sponsor](https://camo.githubusercontent.com/fab14b7f7f475072ada0473f193d6f322561fd4a2958e0cc89910d053347cf27/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53706f6e736f722d2532336561346161613f6c6f676f3d67697468756273706f6e736f7273266c6f676f436f6c6f723d7768697465266c6162656c436f6c6f723d306431313137)](https://github.com/sponsors/byjg)[![Build Status](https://github.com/byjg/php-rest-reference-architecture/actions/workflows/build-app-image.yml/badge.svg?branch=master)](https://github.com/byjg/php-rest-reference-architecture/actions/workflows/build-app-image.yml)[![Opensource ByJG](https://camo.githubusercontent.com/425c1bbccc0f292bf4d20569ae74a6b2e384fd648f1af8911bc61de9a8dcfc0b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6f70656e736f757263652d62796a672d737563636573732e737667)](http://opensource.byjg.com)[![GitHub source](https://camo.githubusercontent.com/88e61eb211719144efdd570290a0456b6e13099c2df8d973f1bb43fe33bf0039/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4769746875622d736f757263652d696e666f726d6174696f6e616c3f6c6f676f3d676974687562)](https://github.com/byjg/php-rest-reference-architecture)[![GitHub license](https://camo.githubusercontent.com/f9be9535c2146af6f2e78faa5a2e22f28422deffe38ee6be938c6eb389922738/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f62796a672f7068702d726573742d7265666572656e63652d6172636869746563747572652e737667)](https://opensource.byjg.com/license/)[![GitHub release](https://camo.githubusercontent.com/de7f5e9809d443bb396f2ccda99e3e2fa70140c9abdd1cd8458010ff6c9dc628/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f62796a672f7068702d726573742d7265666572656e63652d6172636869746563747572652e737667)](https://github.com/byjg/php-rest-reference-architecture/releases) **Production-ready PHP REST API boilerplate** that lets you focus on building your business logic, not the infrastructure. Why Use This? ------------- [](#why-use-this) Every new REST API needs the same boilerplate: authentication, migrations, an ORM, OpenAPI docs, a test harness, and a DI container. Setting all of that up correctly takes days โ€” and it's not the work your users care about. This template does the wiring once, correctly, so you start on day one writing business logic instead of plumbing. And because it's a **template you own** โ€” not a framework you depend on โ€” you can change, remove, or replace any part of it without asking permission. Quick Start ----------- [](#quick-start) ``` # Create your project composer -sdev create-project byjg/rest-reference-architecture my-api ^6.1 # Start containers cd my-api docker compose up -d # Run migrations composer migrate -- --env=dev reset # Your API is ready! curl http://localhost:8080/sample/ping ``` **๐Ÿ“š [Complete Getting Started Guide โ†’](docs/getting-started/installation.md)** Architecture Overview --------------------- [](#architecture-overview) ``` mindmap (("Reference Architecture")) ("PSR Standards") ("WebRequests") ("Container & Dependency Injection") ("Cache") ("Authentication & Authorization") ("Decoupled Code") ("Database") ("ORM Integration") ("Migration") ("OpenAPI Integration") ("Routing") ("Rest Methods") ("Contract Testing") ("Documentation") ("Error Handling") ``` Loading Key Features ------------ [](#key-features) - ๐Ÿš€ **Code generator** โ€” one command scaffolds Model, Repository, Service, REST controller, and tests from any database table - ๐Ÿ—๏ธ **Two patterns** โ€” choose Repository (DI + Service layer) or ActiveRecord per entity; mix them in the same project - ๐Ÿ” **Auth out of the box** โ€” JWT login, token refresh, password reset, and role-based access control (RBAC) included - ๐Ÿ“– **OpenAPI-first** โ€” routes are driven by `openapi.json`; Swagger UI, contract testing, and docs stay in sync automatically - ๐Ÿ—„๏ธ **Database migrations** โ€” versioned up/down SQL migrations with a one-command runner and ORM integration - ๐Ÿงช **In-process testing** โ€” `FakeApiRequester` runs the full API stack inside PHPUnit, no web server needed - ๐Ÿณ **Docker ready** โ€” MySQL, PHP-FPM, and Nginx pre-configured; `docker compose up -d` and you're running - โš™๏ธ **PSR standards** โ€” PSR-7 (HTTP messages), PSR-11 (container), PSR-6/16 (cache) ``` # Generate a complete CRUD API from a single table composer codegen -- --env=dev --table=products all --save ``` Documentation ------------- [](#documentation) ### Getting Started [](#getting-started) 1. **[Installation & Setup](docs/getting-started/installation.md)** โ€“ Install the template, configure environments, and review prerequisites. 2. **[Create Your First Table](docs/getting-started/first-table.md)** โ€“ Define your first migration and schema. 3. **[Add Fields](docs/getting-started/add-field.md)** โ€“ Safely evolve existing tables. 4. **[Create REST Endpoints](docs/getting-started/first-endpoint.md)** โ€“ Generate REST handlers from your tables. 5. **[Windows Setup](docs/getting-started/windows.md)** โ€“ WSL/Windows-specific checklist. 6. **[Unattended Setup](docs/getting-started/unattended-setup.md)** โ€“ Automate installs for CI/CD pipelines. ### Guides [](#guides) - **[REST Controllers](docs/guides/rest-controllers.md)** โ€“ Define routes with PHP attributes; keep controllers thin. - **[Authentication](docs/guides/authentication.md)** โ€“ Configure JWT login flows and RBAC enforcement. - **[Database Migrations](docs/guides/migrations.md)** โ€“ Version and run schema migrations in every environment. - **[ORM](docs/guides/orm.md)** โ€“ Use MicroORM for repository and ActiveRecord patterns. - **[Service Layer](docs/guides/services.md)** โ€“ Organize business logic, orchestration, and transaction boundaries. - **[Repository Patterns](docs/guides/repository-advanced.md)** โ€“ Implement complex queries, UUID handling, and filtering helpers. - **[Template Customization](docs/guides/templates.md)** โ€“ Tailor the generator templates to match your coding standards. - **[Testing](docs/guides/testing.md)** โ€“ Unit, integration, and contract testing with `FakeApiRequester`. - **[JWT Authentication Advanced](docs/guides/jwt-advanced.md)** โ€“ Extend tokens with custom claims and refresh logic. - **[Error Handling](docs/guides/error-handling.md)** โ€“ Map exceptions to HTTP responses and logging patterns. - **[Configuration](docs/guides/configuration.md)** โ€“ Layer configurations, secrets, and environment overrides. ### Concepts [](#concepts) - **[Architecture](docs/concepts/architecture.md)** โ€“ Architectural decisions: when to use Repository vs ActiveRecord. - **[OpenAPI Integration](docs/concepts/openapi-integration.md)** โ€“ How swagger-php, the spec file, and Swagger UI fit together. - **[Dependency Injection](docs/concepts/dependency-injection.md)** โ€“ PSR-11 container, environment hierarchy, and DI binding patterns. - **[Request Lifecycle](docs/concepts/request-lifecycle.md)** โ€“ Trace an HTTP request from entry point to JSON response. ### Reference [](#reference) - **[Code Generator](docs/reference/code-generator.md)** โ€“ Automate models, repositories, services, controllers, and tests. - **[Attributes](docs/reference/attributes.md)** โ€“ `RequireAuthenticated`, `RequireRole`, `ValidateRequest`, and custom attributes. - **[Traits](docs/reference/traits.md)** โ€“ Timestamp and soft-delete helpers for models. - **[Scriptify](docs/reference/scriptify.md)** โ€“ REPL, CLI runner, and service manager utilities. - **[Components](docs/reference/components.md)** โ€“ Full PHP component dependency graph. Real-World Example ------------------ [](#real-world-example) ``` # 1. Create database table cat > db/migrations/up/00002-create-products.sql