README

Laravel Light API包旨在帮助用户为Laravel中的所有模型创建API。使用此包，您可以轻松地为模型生成API路由，节省时间和精力。

安装

要安装此包，请在Laravel项目中运行以下命令

$ composer require manianrezaei/laravel-light-api

安装包后，您可以通过以下步骤开始使用它

发布包供应商
```
$ php artisan vendor:publish
```

然后选择包提供者 ManianRezaei\LaravelLightApi\providers\ApiLightServiceProvider

使用以下命令优化API路由
```
  $ php artisan optimize 
```
这就完成了！现在您已经为所有模型设置了API路由和控制器。

用法

Laravel Light Api端点默认为/apilight

要更改端点并配置可访问的模型，请参阅config/apilight.php。

设置基本端点

 'endpoint' => "/apilight",

可以通过API访问的模型列表

'permissions'=>[
       "usr"=> [
            "model"=> \App\Models\User::class,
            "allowlist" =>[
                'id',
                'updated_at',
                'created_at'
            ]
        ]
    ]

"权限"包含LightAPI中允许的模型数组。

为了隐藏模型名称，您可以指定一个别名。在上面的示例中，"usr"是模型的别名，该模型的端点将为/apilight/usr。

所有可选字段都应添加到allowlist中。

自定义选择

默认情况下，LightAPI会选择每个查询中所有白名单字段。

所选字段可以像这样在查询字符串中指定

/apilight/usr?select=id,created_at

贡献

如果您想为此包做出贡献，请随意在GitHub上将其仓库分叉并提交一个pull request。我们欢迎任何贡献并感谢您的支持。

许可证

此包为开源，并按照MIT许可证发布。您可以根据许可证条款自由使用、修改和分发它。

有关更多信息，请参阅GitHub仓库。

manianrezaei / laravel-light-api

维护者

详细信息

README

安装

用法

自定义选择

贡献

许可证