qujsh/laravel-response

这是一个针对特殊模板的中间件,用于设置响应信息

dev-master 2019-04-09 08:10 UTC

This package is auto-updated.

Last update: 2024-09-09 20:34:03 UTC


README

response custom,定制 response 返回值

响应结果

使用中间件来处理错误响应;结果模板如

http status: 200 OK
{
    "message": "The password field is required.",
    "code": "4220000",
    "extra": {
        "status_code": 422,
        "message": "422 Unprocessable Entity"
    }
}

状态码由 "http code" + 0000 组成;

PS:404 未找到,405 方法不允许,需要单独处理,因为它在中间件之前获取结果,无法控制

Laravel

此包适用于 Laravel 5.4 或更高版本。您可以通过 composer 安装此包

composer require qujsh/laravel-response

在 Laravel 5.5 中,服务提供程序将自动注册。

您可以使用以下命令发布迁移:

php artisan vendor:publish --provider="Qujsh\Response\ResponseServiceProvider"

使用中间件

此包包含 ResponseCustomMiddleWare 中间件。您可以在 app/Http/Kernel.php 文件中添加它们。

protected $routeMiddleware = [
    // ...   
    'responseCustom' => \Qujsh\Response\Middlewares\ResponseCustomMiddleWare::class, 
];

然后您可以使用中间件规则保护您的路由

Route::group(['middleware' => ['responseCustom]], function () {
    //
});

Route::group(['middleware' => ['responseCustom:default']], function () {
    //
});

PS:您应该将此中间件作为第一个队列中的中间件添加(先入后出),此插件的基础是解决错误结果,并从我们在 config/message.php 文件中设置的数组中获取指定信息。