README

概述

Laravel API Respond 是一个用于简化 Laravel 应用程序中生成 JSON 响应过程的包。它提供了一种方便的方式来构建具有一致键和格式的响应，使 API 开发更加高效。

安装

您可以通过运行以下命令使用 Composer 安装此包：

composer require hassankerdash/laravel-api-respond

使用方法

安装后，您可以使用包提供的 Respond 服务在 Laravel 控制器或服务中生成 JSON 响应。

基本用法

// Generate a successful response
return respond()->success(['key' => 'value'], 'Operation completed successfully');

// Generate an error response
return respond()->error('Bad request');
respond()->error('Bad request')->throwResponse();

方法

Respond 服务提供了以下方法来生成 JSON 响应：

success($data, $message = null, $code = 200, $status = true)：生成一个成功的响应。
error($message, $data = null, $code = 400, $status = false)：生成一个错误响应。
ok($data, $message = null, $code = 200, $status = true)：生成一个指示成功并带有状态码 200 的响应。
created($data, $message = null, $code = 201, $status = true)：生成一个指示成功资源创建的响应。
accepted($data, $message = null, $code = 202, $status = true)：生成一个指示请求已接受处理的响应。
noContent($message = null, $code = 204, $status = true)：生成一个无内容的响应。
badRequest($message, $data = null, $code = 400, $status = false)：生成一个指示请求错误的响应。
notFound($message, $data = null, $code = 404, $status = false)：生成一个指示请求的资源未找到的响应。
methodNotAllowed($message, $data = null, $code = 405, $status = false)：生成一个指示请求方法不被允许的响应。
conflict($message, $data = null, $code = 409, $status = false)：生成一个指示冲突的响应。
...（更多）

许可证

此包是开源软件，许可协议为 MIT 许可。

作者

Hassan Kerdash

贡献

欢迎贡献！请随意在 GitHub 上提交问题或拉取请求。

支持

有关任何问题或支持，请通过 GitHub Issues 联系 Hassan Kerdash。

变更日志

有关更改的详细信息，请参阅 CHANGELOG.md 文件。

版本控制

此包遵循语义版本控制。

安全漏洞

如果您在此包中发现安全漏洞，请通过 kerdash@gmail.com 发送电子邮件给 Hassan Kerdash。所有安全漏洞都将得到及时处理。

hassankerdash / laravel-api-respond

维护者

详细信息