README

轻松响应API请求。

需求

Laravel >= 5.5

安装

您可以通过composer安装此包。

$ composer require laratoolbox/responder

用法

安装后，您可以使用助手函数 responder。

return responder()
        ->addHeader('X-Secret1', 'secret1')
        ->addHeader('X-Secret2', 'secret2')
        ->addHeader('X-Secret3', 'secret3')
        ->setData(\App\Models\User::select('id', 'name')->find(1))
        ->addExtraData('custom-key', 'custom-value')
        ->send();

请参见以下响应

HTTP/1.1 200 OK
Content-Type: application/json
X-Secret1: secret1
X-Secret2: secret2
X-Secret3: secret3

{
    "code": 0,
    "message": null,
    "data": {
        "id": 1,
        "name": "Semih ERDOGAN"
    },
    "custom-key": "custom-value"
}

此外，您还可以在任何需要时抛出 ResponderException。

throw new \LaraToolbox\Responder\Exceptions\ResponderException(
    \LaraToolbox\Responder\ResponseCodes::ERROR,
    $customData = [1,2,3]
);

请参见以下响应

HTTP/1.1 200 OK
Content-Type: application/json

{
    "code": 120,
    "message": "An error occurred",
    "data": [
        1,
        2,
        3
    ]
}

responder具有的所有方法。

send

• 参数 null|mixed $data（如果设置，则在幕后调用setData方法）

setHttpStatusCode

• 参数 int $statusCode

setResponseMeta

• 参数 array $responseMeta

setResponseCode

• 参数 int $responseCode

setResponseMessage

• 参数 string $responseMessage

setData

• 参数 mixed $data

addExtraData

• 参数 string $key
• 参数 mixed $value

addHeader

• 参数 string $key
• 参数 string|integer|numeric $value

测试

// TODO

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

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

鸣谢

• Semih ERDOGAN
• Dincer DEMIRCIOGLU
• 所有贡献者

许可证

MIT许可证（MIT）。有关更多信息，请参阅 许可证文件。