README

英文描述 | 俄文描述

Laravel 5 API

此包允许轻松快速地设置API的基础。

内容

• 安装
• Laravel中设置
• Lumen中设置
• 许可

安装

使用以下命令使用composer安装此包

composer require bwt-team/laravel-api

Laravel中设置

当composer更新时，将服务提供者添加到config/app.php中的providers数组中。

BwtTeam\LaravelAPI\Providers\ApiServiceProvider::class

此服务提供者将注册api宏，以便更舒适地工作。您将在api格式中拥有以下调用格式

response()->api($data)

在完整格式中，它将如下所示

new \BwtTeam\LaravelAPI\Response\ApiResponse($data)

此外，此服务提供者允许发布配置文件，以便根据您的需求更新包设置。使用以下命令进行发布

php artisan vendor:publish --provider="BwtTeam\LaravelAPI\Providers\ApiServiceProvider" --tag=config

为了使所有响应（包括警报等）以相同的格式发送，将App\Exceptions\Handler类中的类父类更改为\BwtTeam\LaravelAPI\Exceptions\Handler。

class Handler extends \BwtTeam\LaravelAPI\Exceptions\Handler

并且中间件\BwtTeam\LaravelAPI\Middleware\Api应连接到特定路径（或整个应用）以使该路径被视为API方法。

如果您使用App\Http\Requests类实例进行验证，则需要从BwtTeam\LaravelAPI\Requests\ApiRequest继承，而不是从Illuminate\Foundation\Http\FormRequest继承。

Lumen中设置

在composer更新后注册服务提供者，通过将以下行添加到bootstrap/app.php中

$app->register(\BwtTeam\LaravelAPI\Providers\ApiServiceProvider::class);

将配置文件vendor/bwt-team/laravel-api/config/api.php复制到配置目录，该目录位于根目录中（如果不存在，则自行创建）并根据您的需求进行设置。要在bootstrap/app.php中从该文件加载设置，请添加以下行

$app->configure('api');

为了使所有响应（包括警报等）以相同的格式发送，将App\Exceptions\Handler类中的类父类更改为BwtTeam\LaravelAPI\Exceptions\LumenHandler。

class Handler extends \BwtTeam\LaravelAPI\Exceptions\LumenHandler

并且中间件\BwtTeam\LaravelAPI\Middleware\Api应连接到特定路径（或整个应用）以使该路径被视为API方法。

许可

此包使用MIT许可。