gzhpackages/laravel-json-api

There is no license information available for the latest version (1.3) of this package.

提供统一返回格式和错误处理方式

1.3 2021-07-22 01:39 UTC

Requires

• php: ^7.0
• illuminate/config: ~5.0|~6.0
• illuminate/http: ^5.1|^6
• illuminate/support: ~5.0|~6.0

Requires (Dev)

• illuminate/console: ^5.1|^6

Unknown License

• mervynyang

README

主要是为了统一前后端 restful api 的返回格式标准，按照 https://jsonapi.org 定义返回指定的数据格式。

最好结合前端库 json-api-fetch 一起使用。

安装

从composer安装

composer require gzhpackages/laravel-json-api

添加service provider

in laravel:

在 config/app.php 中的 providers 添加

'providers' => [
    ...
    GzhPackages\JsonApi\Providers\LaravelServiceProvider::class,
]

in lumen:

在 bootstrap/app.php 中添加

$app->register(GzhPackages\JsonApi\Providers\LaravelServiceProvider::class);

发布配置

php artisan vendor:publish --provider "GzhPackages\JsonApi\Providers\LaravelServiceProvider"

使用

Controller

添加一个 trait 给response，ApiHelper包含了4个常用的返回值和status code类型。

分别为 content, noContent, created, accepted

namespace App\Http\Controllers;

use GzhPackages\JsonApi\Traits\ApiHelper;
use Illuminate\Routing\Controller as BaseController;

class Controller extends BaseController
{
    use ApiHelper;

    public function show()
    {
        // do something...
        return $this->content(['foo' => 'bar']);        
    }
    
    public function create()
    {
        // do something...
        return $this->created();
    }
}

Exception

1、重写 app/Exceptions/Handler.php 的render方法

function render($request, Exception $exception)
    {
        $rendered = parent::render($request, $exception);

        if (config('app.debug')) {
            return $rendered;
        }

        $status = $rendered->getStatusCode();
        $json = [
            'error' => array_merge(config('errors.server_error'), [
                'title' => 'SERVER_ERROR',
            ]),
        ];
        
        /* 捕获自定义错误 */
        if ($exception instanceOf \GzhPackages\JsonApi\Exceptions\BaseApiException) {
            $json = $exception->toArray();
            $status = $exception->getStatus();
        }
        
        /* 自定义内置的错误，统一返回json */
        if ($exception instanceOf \Symfony\Component\HttpKernel\Exception\NotFoundHttpException) {
            $json = [
                'error' => array_merge(config('errors.not_found'), [
                    'title' => 'NOT_FOUND',
                ]),
            ];           
            $status = 404;
        }

        if ($exception instanceOf \Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException) {
            $json = [
                'error' => array_merge(config('errors.method_not_allowed'), [
                    'title' => 'METHOD_NOT_ALLOWED',
                ]),
            ];    
            $status = 405;
        }

        return response()->json($json, $status);
    }

2、命令行创建一个新的 Exception 类

php artisan make:api-exception NotFoundException

3、根据标准修改 http 状态码

class NotFoundException extends BaseApiException
{
    protected $status = 404;
}

4、在 config/errors.php 中配置错误详情

在字段detail中，可以用大括号 {} 占位符

'not_found_user' => [
    'code'   => 10003,
    'detail' => '未找到该用户 {name}',
],

5、抛出自定义异常

第二个参数为 detail 占位符替换的对象，如果自定义的detail中无占位符，第二个参数可为空

throw new NotFoundException('not_found_user', ['name' => 'xiaoming']);

自定义meta信息：

$exception = new NotFoundException('not_found_user');
$exception->withMeta(['language' => 'en']);
throw $exception;