laravel-responder

项目介绍：Laravel Responder

Laravel Responder 是一个用于构建 API 响应的插件，旨在将 Fractal 集成到 Laravel 和 Lumen 中。它可以使用转换器对数据进行转换，创建和序列化成功或错误响应，处理异常，并帮助您测试响应。

为什么选择 Laravel Responder？

在 Laravel 中，可以直接从控制器方法返回模型以将其转换为 JSON，这是一种快速构建 API 的方式，但容易暴露数据库列。Fractal，通过引入转换器解决了这个问题，但整合到框架中可能有些麻烦。Laravel Responder 提供了更简洁的方式，使代码更加优雅：

例如，将常见的数据库返回简化为：

public function index()
{
    return responder()->success(User::all())->respond();
}

这样，不仅可以保持代码的整洁性，还可以充分利用 Fractal 的强大功能，同时藏在精美的抽象后面。

系统要求

• PHP 7.0 或更高版本
• Laravel 5.1 或更高版本或 Lumen 5.1 或更高版本

安装

通过 Composer 安装：

composer require flugger/laravel-responder

如果你使用的是 Laravel 5.5 或更高版本，包会自动发现，无需手动注册服务提供者和门面。

使用

创建响应

你可以使用 Responder 服务类中的 success 和 error 方法来构建成功或错误响应。在控制器方法中，直接注入 Responder 服务类即可：

public function index(Responder $responder)
{
    return $responder->success();
}

你也可以使用 responder 辅助函数：

return responder()->success();

创建成功响应

可使用 success 方法为响应设置数据，支持不同类型的数据，包括查询构建器实例：

return responder()->success(Product::all())->respond();

创建转换器

转换器类提供了一个转换数据的便利之地，并允许你在多个地方重用转换器。可以通过 Artisan 命令创建转换器：

php artisan make:transformer ProductTransformer

创建错误响应

当 API 消费者执行意外操作时，可以返回描述问题的错误响应：

return responder()->error('sold_out_error', 'The requested product is sold out.')->respond();

处理异常

为了提高用户体验，Laravel Responder 提供了处理异常的能力。替换或使用包的异常处理器，异常将自动转化为错误响应。

贡献与支持

任何贡献都非常欢迎，可以在 Github 上创建拉取请求。如果您发现漏洞或有改进建议，也可以提交问题。

捐赠

这个包是免费使用的，但如果您想表示感谢，可以通过 PayPal 捐赠支持包的开发。

授权

Laravel Responder 是在 MIT 许可下发布的免费软件。