akill/message

此消息用于输出 json 或 html

dev-master 2020-09-28 21:34 UTC

This package is auto-updated.

Last update: 2024-09-29 04:14:41 UTC


README

FOSSA Status

一个用于 JSON 响应 API 和 HTML 响应(即将推出)的客户端最小包,适用于 Laravel。

入门

通过 composer 安装此包。

使用 composer 下载包

composer require akilsagitarius/message

或者

{
	"require": {
		"akilsagitarius/message" : "dev-master"
	}
}

注册服务提供者。

此包利用 Laravel 自动发现服务提供者。如果您使用的是 Laravel 的早期版本(< 5.4),您需要手动注册服务提供者。

akilsagitarius\message\MessageServiceProvider::class 添加到 config/app.php 文件中的 providers 数组。

示例

'providers' => [
	....
	
	akilsagitarius\message\MessageServiceProvider::class,
]

注册服务提供者。

现在,将配置代码响应发布到您的提供者

php artisan vendor:publish --tag=public --force

用法

基本

注意:返回的响应代码将同时设置为实际的 HTTP 头部响应代码。

常规响应

这是一个简单响应

Route::get('/message', function () {
    $reuslt = Message::success(200)->get();
    return $reuslt;
});

将导致以下结构化结果

{
    code: 200,
    result: "Success",
    message: "OK"
}

次要响应

这是一个包含您发送结果的响应

Route::get('/mess', function () {
    $array = array(
        'first' => 'This is first data',
        'second' => 'This is second data',
    );
    $reuslt = Message::success(200)->payload($array)->get();
    return $reuslt;
});

将导致以下结构化结果

{
    code: 200,
    result: "Informational",
    message: "OK",
    payload: {
        first: "This is first data",
        second: "This is second data"
    }
}

作者

*Muhammad Akil - 初始工作 - Akill

许可

FOSSA Status

FOSSA Status

致谢

  • 感谢任何使用过其代码的人
  • 灵感