bycedric / allay
在几分钟内构建可扩展的RESTful API。
Requires
- php: ^7.0
- illuminate/contracts: ^5.5
- illuminate/database: ^5.5
- illuminate/http: ^5.5
- illuminate/support: ^5.5
Requires (Dev)
- illuminate/routing: ^5.5
- laravel/lumen-framework: ^5.5
- mockery/mockery: ^0.9
- phpunit/phpunit: ^5.0
- satooshi/php-coveralls: ^0.6
This package is not auto-updated.
Last update: 2024-09-19 15:19:22 UTC
README
Allay
是一个Laravel助手,可以轻松创建RESTful API。它基于资源负责其自身行为的理念设计。这些RESTful行为每个都由一个适用于所有资源的样板控制器启用。 Allay
的每个部分都是可定制和可扩展的,使其适用于多种用例。
要求
Allay
将与以下要求一起工作。
- PHP 7.0+
- Laravel 5.5+
安装
Composer
Composer 是一款优秀的工具,用于在PHP中下载和管理外部包。如果您仍然生活在黑暗时代,请查看他们的网站。
您可以在 composer.json 的 require 部分添加 Allay
。
{ "require": { "bycedric/allay": "0.3.*" } }
或者,在您的 CLI 中执行以下代码。
$ composer require bycedric/allay
Laravel
在 composer 安装后,我们需要将其添加到 Laravel 中。这可以通过将以下代码添加到 /config/app.php 来完成。
'providers' => [ /* * Laravel Framework Service Providers... */ ..., /* * Application Service Providers... */ ..., ByCedric\Allay\Providers\LaravelServiceProvider::class, ]
请将服务提供者添加到提供者列表的 底部。如果不这样做,则无法覆盖路由。
Lumen
您还可以通过将以下代码添加到 /bootstrap/app.php 在 Lumen(一个轻量级且速度极快的Laravel版本)上运行 Allay
。
/* |-------------------------------------------------------------------------- | Register Service Providers |-------------------------------------------------------------------------- ... */ $app->register(ByCedric\Allay\Providers\LumenServiceProvider::class);
用法
要开始使用 Allay
,请查看 wiki(即将推出)页面。
扩展
Allay
被设计成在尽可能多的用例中都有用,因此核心是无偏见的。从那里,您可以走自己的路。为了帮助您做到这一点,这里有一些扩展。
- JSON API(即将推出)
变更日志
请查看 CHANGELOG 了解最近发生了什么更改。
测试
如果您想扩展 Allay
,请确保运行测试以验证代码。
$ composer test
贡献
请查看 CONTRIBUTING 了解详细信息。
安全性
如果您发现任何与安全性相关的错误,请通过电子邮件 me@bycedric.com 而不是使用问题跟踪器。
鸣谢
许可证
MIT许可证(MIT)。有关更多信息,请参阅 许可证文件。