ijodkor/laravel-api-response

Laravel 的响应工具

1.2.0 2024-07-26 05:46 UTC

This package is not auto-updated.

Last update: 2024-09-26 13:30:15 UTC


README

Laravel API Response 是一个用于生成 HTTP JSON 响应并提供异常转换和格式化的库,适用于 Laravel。

Laravel API Response 是一个帮助提供和渲染一致的 HTTP JSON 响应以及将异常转换为 JSON 响应的包。

要求(Requirements)

  • PHP ^8.1
  • Laravel ^10 | ^11

版本兼容性(Version Compatibility)

安装(Installation)

通过 composer 安装此包

composer require ijodkor/laravel-api-response

使用(Usage)

将 RestResponse 特性添加到应用模块的 Controller 文件或任何需要的控制器中

use Ijodkor\ApiResponse\Responses\RestResponse;

class Controller extends Controller {
    use RestResponse;
}

...

class UserController extends Controller {
    public function () {
        return $this->success([
            'user' => new User();
        ]);
    }
}

现有功能(Available functions)

附加功能(Bonus)

此包还提供了 RestRequest 用于返回 JSON 响应的请求验证

use Ijodkor\ApiResponse\Requests\RestRequest;

// class UserRequest extends FormRequest - x
class UserRequest extends RestRequest {

}

参考资料(References)

有用链接(Links)