README

对于Restful API

Laravel在将我们的响应格式化为JSON并适当地使用application/json内容类型踢出方面做得很好，但它并不能帮助处理任何类型的标准输出格式，比如在响应中包含“状态”或“消息”。这个类允许我们标准化所有我们的Restful响应。

安装

$ composer require lowfrequency/api-response

用法

这旨在在您的控制器中按方法使用。请将以下内容添加到控制器的顶部

use LowFrequency\ApiResponse\APIResponse;

示例方法

public function store(Request $request)
{
    $return = new APIResponse();

    // If something fails on execution, Maybe a query does not
    // return anything...
    $return->set_code(401);
    $return->addMessage("Model Not Found");


    // Add the payload. Can be any array or value and will return JSON
    $return->add_data( 'data', [
    	'foo'	=> 'bar',
        'bar'	=> true
    ]);
    $return->add_data( 'foo', 'bar');

    // Return the response.
    return $return->response();
}

示例输出

{
	"status": 401,
    "messages": [
    	"Model Not Found"
    ],
    "data": {
       	"foo": "bar",
    	[
        	"foo": "bar",
            "bar": true
        ]
    },
    "completed_at": "2019-06-06 12:06:33"
}