jncalderon / laravel-api

用于 Laravel 后端

v1.0.6 2022-07-11 20:20 UTC

This package is auto-updated.

Last update: 2024-09-12 01:04:51 UTC


README

这个包帮助我在后端项目中处理一些重复性的事情。

所需包

安装

composer require jncalderon/laravel-api

使用

JSON 响应

{
  "count": 2,
  "data": [
    {
      "id": 1,
      "name": "Jonh",
      "lastName": "Smith"
    },
    {
      "id": 2,
      "name": "Jonh",
      "lastName": "Smith"
    }
  ]
}

门面

辅助函数

可以通过以下辅助函数访问门面

api()->jsonResponse();
transformer()->camelcaseArray();

错误处理器

不要将异常处理到 JSON 中,将文件 app\Exceptions\Handler.php 的扩展名更改为

<?php

namespace App\Exceptions;

use Jncalderon\LaravelApi\Exceptions\Handler as JnHandler;

class Handler extends JnHandler
{
    // no require additional methods and properties
}

中间件

app\Http\Kernel.php 中可以添加以下中间件。

    protected $middlewareGroups = [
        'api' => [
           ...
           \Jncalderon\LaravelApi\Http\Middleware\JsonDebugbar::class,
           \Jncalderon\LaravelApi\Http\Middleware\ConvertRequestFieldsToCamelCase::class,
           \Jncalderon\LaravelApi\Http\Middleware\Localization::class,
           \Jncalderon\LaravelApi\Http\Middleware\SentryUser::class,
        ],
    ];

贡献

欢迎 Pull requests。对于主要更改,请先提交一个问题来讨论您想进行什么更改。

请确保根据需要更新测试。

许可证

MIT