juanyaolin/laravel-api-response-builder

一个用于轻松构建JSON API响应的Laravel包。

1.0.1 2024-04-04 16:28 UTC

This package is auto-updated.

Last update: 2024-09-04 17:52:45 UTC


README

提示

这是英文版的README,如需中文版请访问此处查阅。

Api Response Builder(即本项目)是一个Laravel库,帮助开发者轻松、规范、自定义地构建JSON API响应。

ApiResponseBuilder受到了marcin-orlowski/laravel-api-response-builder的启发,并对其功能进行了调整。

安装

要安装此包,请使用Composer运行

composer require juanyaolin/laravel-api-response-builder

基本用法

安装后,ApiResponse外观已经准备好构建响应。

use Juanyaolin\ApiResponseBuilder\Facades\ApiResponse;

...

// Success response
return ApiResponse::success();

// Error response
return ApiResponse::error();

您将得到以下响应。

// success
{
    "success": true,
    "code": 0,
    "message": "Success",
    "data": null,
}

// error
{
    "success": false,
    "code": -1,
    "message": "Error",
    "data": null
}

更多详细信息请参阅文档