rickgoemans / laravel-api-response-helpers
一个用于创建统一API响应的Laravel辅助工具
v6.0.1
2024-03-13 07:58 UTC
Requires
- php: ^8.2
- illuminate/contracts: ^11.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- larastan/larastan: ^2.8
- laravel/pint: ^1.13
- nunomaduro/collision: ^8.1
- orchestra/testbench: ^9.0
- pestphp/pest: ^2.34
- pestphp/pest-plugin-arch: ^2.5
- pestphp/pest-plugin-laravel: ^2.3
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
README
一个用于创建统一API响应的Laravel辅助工具
此包包含一些有用的辅助函数,用于以统一格式返回API响应。
安装
您可以通过composer安装此包
composer require rickgoemans/laravel-api-response-helpers
使用方法
use Rickgoemans\LaravelApiResponseHelpers\ApiResponse; class ExampleController extends Controller { public function default(): JsonResponse { return ApiResponse::default([ 'message' => 'This is an example', ], 200); } public function success(): JsonResponse { return ApiResponse::success('Ths is an example', [ 'user_id' => 1, 'name' => 'Rick Goemans', ], 200); } public function error(): JsonResponse { return ApiResponse::error('Invalid data', [ 'name' => [ 'required', ], ], 422); } public function unauthorized(): JsonResponse { return ApiResponse::unauthorized(401); } public function forbidden(): JsonResponse { return ApiResponse::forbidden(403); } }
测试
composer test
变更日志
有关最近更改的更多信息,请参阅变更日志。
贡献
有关详细信息,请参阅贡献指南。
安全漏洞
请查阅我们的安全策略,了解如何报告安全漏洞。
致谢
许可协议
MIT许可协议(MIT)。有关更多信息,请参阅许可文件。