README

用于以规范化和易于消费的方式构建API响应的Laravel包。

✨ 特性

ApiResponse 中间件用于设置 Accept: application/json 标头到你的API路由，并且可以抛出JSON异常。
一系列宏，扩展Laravel的响应类，可以像 response()->success(...) 一样轻松使用
生成 _ide_helper_macros.php 文件以改善你的IDE代码补全

1️⃣ 安装

您可以通过composer安装此包

composer require igorsgm/laravel-api-responses

发布配置和IDE辅助文件

php artisan vendor:publish --provider="Igorsgm\LaravelApiResponses\LaravelApiResponsesServiceProvider"

2️⃣ 使用

首先，在 app/Http/Kernel.php 中，在API中间件组的顶部注册 ApiResponse。

class Kernel extends HttpKernel
{
    protected $middlewareGroups = [
        // ...
        'api' => [
            \Igorsgm\LaravelApiResponses\Http\Middleware\ApiResponse::class,
            // ...
        ],
    ];
    
    // ...
}

现在，简单地开始使用可用的响应函数之一，以便在你的控制器中始终返回规范化的API数据。

response()->success($data, $message) // ($data = [], $message = '', $status = 200, $headers = [])
response()->successMessage($message) // ($message = '', $status = 200, $headers = [])
response()->error($errors) // ($errors = [], $message = '', $status = 500, $headers = [])
response()->errorMessage($message) // ($message = '', $status = 500, $headers = [])
response()->exceptionError($exception) // ($exception, $message = '', $status = 0, $headers = [])

测试

composer test

更新日志

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

贡献

请参阅贡献以获取详细信息。

鸣谢

Igor Moraes

许可证

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

igorsgm / laravel-api-responses

维护者

详细信息

README

✨ 特性

1️⃣ 安装

2️⃣ 使用

测试

更新日志

贡献

鸣谢

许可证