neography7/easy-response

具有简单易用性的标准化REST API响应。

1.0.0 2023-06-30 18:29 UTC

This package is auto-updated.

Last update: 2024-09-08 00:19:42 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

Easy Response 允许您轻松创建REST回调。此包有3种创建回调的方式,您可以根据需要使用。但如果它适合您,辅助器将更加简单和清晰。

此包遵循PSR-2和PSR-4标准。

安装

您可以通过composer安装此包

composer require neography7/easy-response

用法

有三种使用此包的方式,但建议使用辅助器。

1) 辅助器

easySuccess 辅助器

easySuccess( message, title = null, data = null);
easySuccess(
    message: 'Test message',
    title: 'Test Title',
    data: [
        "key" => "value"
    ]
);

或像这样

easySuccess('Test message', 'Test Title', [ "key" => "value" ]);

easyError 辅助器

easyError( message, title = null, code = null, data = null);
easyError(
    message: 'Test message',
    title: 'Test Title',
    code: 400,
    data: [
        "key" => "value"
    ]
);

或像这样

easyError('Test message', 'Test Title', 400, [ "key" => "value" ]);

2) 类

首先导入类,然后创建实例。

use Neography7\EasyResponse\EasyResponse;

$callback = new EasyResponse;

您可以通过链式方法添加消息、标题、成功、代码、数据或添加自定义键。

$callback->title("Title")
            ->message("Message")
            ->success("true")
            ->response();

响应方法会将所有内容组合成一个数组,然后以JSON回调的形式响应。如果成功设置为true,则响应代码为200。此外,您还可以使用链式方法添加数据、代码和自定义键值。

$callback->title("Error Title")
            ->message("Error message.")
            ->success("false")
            ->code(404)
            ->data["key" => value]
            ->addKey("key", value)
            ->response();

如果您想删除添加的键,可以使用此方法。

$callback->removeKey("key");

3) 静态类

首先导入初始化EasyResponse的类,然后调用您想要使用的成功或错误方法。

use Neography7\EasyResponse\EA;

$callbackSuccess = EA::success($message, $title = null);
$callbackError = EA::error($message, $title = null, $code = null);

使用后必须调用响应方法。

$callback EA::success("Message", "Title")->response();

测试

我推荐使用“nunomaduro/collision”进行测试bench。

php vendor/bin/testbench package:test

路线图

  • 此包已创建
  • 将添加更多辅助功能
  • 将添加初始回调消息及其翻译

变更日志

有关最近更改的更多信息,请参阅CHANGELOG

贡献

有关详细信息,请参阅CONTRIBUTING

安全

如果您发现任何安全问题,请通过电子邮件ilkerakyel97@gmail.com报告,而不是使用问题跟踪器。

致谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件