PHPackages bycedric/allay - 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. [API Development](/categories/api) 4. / 5. bycedric/allay ActiveLibrary[API Development](/categories/api) bycedric/allay ============== Build scalable and restful API's, in minutes. 0.3.0(8y ago)61.8k[1 issues](https://github.com/byCedric/Allay/issues)MITPHPPHP ^7.0 Since Oct 11Pushed 8y ago3 watchersCompare [ Source](https://github.com/byCedric/Allay)[ Packagist](https://packagist.org/packages/bycedric/allay)[ Docs](http://github.com/bycedric/allay)[ RSS](/packages/bycedric-allay/feed)WikiDiscussions master Synced 3d ago READMEChangelogDependencies (9)Versions (7)Used By (0) Allay ===== [](#allay) [![Latest Version on Packagist](https://camo.githubusercontent.com/da33b3f4a05a1cc293ae0b148bb64ccbe2c1200df30924d689a2457369e5a72f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f62794365647269632f416c6c61792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bycedric/allay)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://camo.githubusercontent.com/49315088e09d9e7c05c34814cb718d4b6dbfa922b2ded0744f429755468d5955/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f62794365647269632f416c6c61792f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/byCedric/Allay)[![Coverage Status](https://camo.githubusercontent.com/0413410746756cca81d813572c074ffc180c0a34c17f6152857b8aa4f13c21e0/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f62794365647269632f416c6c61792f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://coveralls.io/r/byCedric/Allay)[![Code Climate](https://camo.githubusercontent.com/7575461d24ed6928f262847e74bb26198621e9c8f5e18792b2c1d5a5feba7457/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636c696d6174652f6769746875622f62794365647269632f416c6c61792e7376673f7374796c653d666c61742d737175617265)](https://codeclimate.com/github/byCedric/Allay)[![Total Downloads](https://camo.githubusercontent.com/bc4b376ea109b480862b7d7c7a006edd7049343c04ec84ada97553634c2f1938/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f62796365647269632f616c6c61792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bycedric/allay) `Allay` is a Laravel helper to easily create restful API's. It's designed based on the idea that the resource is responsible for it's own actions. Each of those restful actions are enabled by a boilerplate controller that works for all resources. Every part of `Allay` is customizable and extendable, making it usable for a lot of usecases. Requirements ------------ [](#requirements) `Allay` will work with the following requirements. - **PHP 7.0+** - **Laravel 5.5+** Install ------- [](#install) ### [Composer](https://getcomposer.org/) [](#composer) Composer is a nice tool to download and manage external packages within PHP. If you still live in the dark ages, take a look at their site. You can add `Allay` within the require section of your composer.json. ``` { "require": { "bycedric/allay": "0.3.*" } } ``` Or execute the following code inside your CLI. ``` $ composer require bycedric/allay ``` ### [Laravel](http://laravel.com/) [](#laravel) After the composer installation, we need to add it to Laravel. This can be done by adding the following code to the **/config/app.php**. ``` 'providers' => [ /* * Laravel Framework Service Providers... */ ..., /* * Application Service Providers... */ ..., ByCedric\Allay\Providers\LaravelServiceProvider::class, ] ``` > Please add the service provider to the **bottom** of the providers list. If you don't, routes cannot be overwritten. ### [Lumen](http://lumen.laravel.com/) [](#lumen) You can also get `Allay` working on Lumen, a light-weight and blazing fast Laravel version. This can be done by adding the following code to the **/bootstrap/app.php**. ``` /* |-------------------------------------------------------------------------- | Register Service Providers |-------------------------------------------------------------------------- ... */ $app->register(ByCedric\Allay\Providers\LumenServiceProvider::class); ``` Usage ----- [](#usage) To get started with `Allay` take a look at the [wiki](../../wiki) (soon available) pages. Extensions ---------- [](#extensions) `Allay` is designed to be useful in as much use cases as possible, therefore the core is unopinionated. From the there, you can go your own way. To help you in that, here are some extensions. - JSON API (soon available) Change log ---------- [](#change-log) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Testing ------- [](#testing) If you want to extend `Allay` make sure you run the tests to validate the code. ``` $ composer test ``` Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Cedric van Putten](https://github.com/byCedric) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 27 — LowBetter than 47% of packages Maintenance17 Infrequent updates — may be unmaintained Popularity20 Limited adoption so far Community8 Small or concentrated contributor base Maturity52 Maturing project, gaining track record 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. ### Release Activity Cadence Every ~156 days Recently: every ~195 days Total 6 Last Release 3136d ago PHP version history (3 changes)0.1.0PHP >=5.5.9 0.2.0PHP >=5.6 0.3.0PHP ^7.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/8f4ce064b5be71889d8571b5e3f9ef66a3c3cace0361966690abd00930b5be7d?d=identicon)[byCedric](/maintainers/byCedric) --- Top Contributors [![byCedric](https://avatars.githubusercontent.com/u/1203991?v=4)](https://github.com/byCedric "byCedric (69 commits)") --- Tags apilaravelbycedricallay ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/bycedric-allay/health.svg) ``` [![Health](https://phpackages.com/badges/bycedric-allay/health.svg)](https://phpackages.com/packages/bycedric-allay) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3355.3M346](/packages/psalm-plugin-laravel)[api-platform/laravel API Platform support for Laravel 58171.6k14](/packages/api-platform-laravel)[larastan/larastan Larastan - Discover bugs in your code without running it. A phpstan/phpstan extension for Laravel 6.5k55.4M8.5k](/packages/larastan-larastan)[laravel/cashier Laravel Cashier provides an expressive, fluent interface to Stripe's subscription billing services. 2.6k29.9M148](/packages/laravel-cashier)[laravel/scout Laravel Scout provides a driver based solution to searching your Eloquent models. 1.7k55.0M619](/packages/laravel-scout)[simplestats-io/laravel-client Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof. 5022.0k](/packages/simplestats-io-laravel-client) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)