Laravel API Response Helpers(响应助手)扩展包，返回统一的api响应

Laravel  /  管理员 发布于 3年前   1228

该扩展包非常适合那种返回大量用于返回错误信息的项目

官方介绍该包的动机主要基于一个非常古老的继承 Laravel 项目。

该项目包含大量用于返回错误的方法/结构

要求版本

PHP ^7.4 | ^8.0
Laravel 6、7 和 8

安装

composer require f9webltd/laravel-api-response-helpers

使用

// 在控制器中使用这个特性

<?php
namespace App\Http\Api\Controllers;

use F9Web\ApiResponseHelpers;

use Illuminate\Http\JsonResponse;

class OrdersController
{
    use ApiResponseHelpers;
    public function index(): JsonResponse
    {
        return $this->respondWithSuccess();
    }
}

// 提供以下方法：

$this->respondNotFound(string|Exception $message, ?string $key = 'error')
$this->respondWithSuccess(?array $contents = [])
$this->respondOk(string $message)
$this->respondUnAuthenticated(?string $message = null)
$this->respondForbidden(?string $message = null)
$this->respondError(?string $message = null)
$this->respondCreated(?array $data = [])
$this->respondNoContent(?array $data = [])

更多更详细的方法请自行上git搜索

这个包的目标是确保整个应用程序的 JSON API 响应一致。

它提供了一种一致的响应方式，而不是手动设计 API 响应：

// IE。
response()->json(['message' => $error], Response::HTTP_BAD_REQUEST)
// 或者
response()->json([$error], 400)

您可以了解有关此包的更多信息、获取完整安装说明并查看 GitHub 上的源代码。

git地址:

https://github.com/f9webltd/laravel-api-response-helpers