鱼沙/api-responser

Laravel API Responser 简化了 Laravel 中的 API 响应处理。轻松格式化、操作和自定义您的响应，减少重复代码并提高响应一致性

维护者

详情

github.com/yushabadri/api-responser

来源

问题

安装: 15

依赖项: 0

建议者: 0

安全: 0

星星: 1

关注者: 1

分支: 0

开放问题: 0

v1.0.3 2024-04-24 07:44 UTC

MIT 66bc123dc01fc40d1b6c8bbc98d150c7a5a6cc8a

  • Farshad Badri Mardakhi

This package is auto-updated.

Last update: 2024-09-24 08:35:58 UTC

README

您的包描述将在这里。

安装

您可以通过 Composer 安装此包。在您的终端中运行以下命令

composer require yusha/api-responser

用法

使用 handle 方法

要在您的控制器或其他类中使用 Responser，只需调用 handle 方法

use Yusha\ApiResponder\Services\Responser;

class SomeController extends Controller
{
    public function someMethod()
    {
        return Responser::handle(Response::HTTP_OK, $data, 'Data successfully returned.');
    }
}

handle 方法参数

handle 方法接受三个参数

  • 状态码：这是将在响应中返回的 HTTP 状态码。它表示请求的状态。例如，Response::HTTP_OK 代表成功响应（状态码 200）。

  • 数据：此参数是可选的，代表您想要包含在响应中的任何附加数据。它可以是一个数组、对象或任何其他您想要与响应一起返回的数据结构。

  • 消息：这是一个可选参数，允许您在响应中包含一条消息。它可以用于提供有关响应的附加信息，例如成功消息或错误消息。以下是如何使用 handle 方法的示例

   return Responser::handle(Response::HTTP_OK, $data, 'Data successfully returned.');

在这个例子中，handle 方法用于创建一个状态码为 200（OK）、$propertiesData 作为数据、消息 'Properties data successfully returned.' 的 JSON 响应。

自定义

您可以通过扩展它并在自己的类中覆盖其方法来自定义 Responser 的行为。

配置

此包不需要任何额外的配置。

测试

您可以使用 PHPUnit 运行包的测试。在您的终端中运行以下命令

composer test

许可证

此包是开源软件，根据MIT 许可证授权。