README

一个用于格式化API响应的小型Laravel包。

安装

通过Composer

$ composer require gaurav93d/laravelresponder

对于Laravel版本 < 5.5，请考虑在 config/app.php 中列出服务提供者和外观

'providers' => [
    ...
    gaurav93d\LaravelResponder\LaravelResponderServiceProvider::class,
    ...
],
'aliases' => [
    ...
    'Responder' => gaurav93d\LaravelResponder\Facades\Responder::class,
    ...
],

使用方法

响应格式

{
  "success": true,
  "status": 200,
  "data": [
    "Here your beautiful data goes"
  ],
  "errors": [
    "Here your ugly errors go"
  ]
}

发送成功

...
use gaurav93d\LaravelResponder\Facades\Responder;
...

Responder::success($data  = [], $status = 200);

发送错误

...
use gaurav93d\LaravelResponder\Facades\Responder;
...

// Multiple errors
return Responder::errors($errors  = [], $status = 200);

// Single error
return Responder::error($message = 'Error!', $status = 200);

// Validation errors
return Responder::respondValidationErrors(Validator $validator);

// Here are some comman error responses 👇

// Internal server error
return Responder::respondInternalError($message = 'Internal Error!'); // status = 500

// Unauthorized error
return Responder::respondUnauthorizedError($message = 'Unauthorized!'); // status = 401

// Bad request error
return Responder::respondBadRequestError($message = 'Bad Request!'); // status = 400

// Not found error
return Responder::respondNotFoundError($message = 'Not found!'); // status = 404

附加响应头

...
use gaurav93d\LaravelResponder\Facades\Responder;
...

return Responder::headers($headers = [])->success($data  = [], $status = 200);
...
return Responder::headers($headers = [])->errors($errors  = [], $status = 200);
...

... 😉 继续关注！更多功能即将到来。

变更日志

请参阅变更日志以获取最近更改的更多信息。

鸣谢

• Gaurav Deshpande

许可证

MIT。请参阅许可证文件以获取更多信息。