README

此包允许您从Laravel API发送优雅的JSON响应。

安装

您可以通过composer安装此包

composer require avertys/json-api-response

使用方法

成功的响应

  return JsonApiResponse::make($data)
        ->withSuccess()
        ->send(200);

添加附加数据

  return JsonApiResponse::make($data)
        ->withSuccess()
        ->withAdditionalData([
            'deprecated' => true
        ])
        ->send(200);

失败的响应

  return JsonApiResponse::make()
        ->withErrors($validator->errors())
        ->withAdditionalData([
            'deprecated' => true
        ])
        ->send(200);

与分页一起工作

  return JsonApiResponse::make(User::paginate(10))
        ->withSuccess()
        ->send(200);

响应格式

{
    "success": true,
    "data": [
        "id": 1,
        "name": "John" 
    ],
    "errors": null,
    "additional_data": [
        "pagination": {
            "current_page": 2,
            "to": 5,
            "total": 100
        },
        "deprecated": false
    ]
}

变更日志

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

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全性

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

avertys / json-api-response

维护者

详细信息

README

安装

使用方法

成功的响应

添加附加数据

失败的响应

与分页一起工作

响应格式

变更日志

贡献

安全性

致谢

许可证

Laravel Package Boilerplate