mrcookie / simple-api-crud-generator

这是我的包 simple-api-crud-generator

0.0.1 2023-09-16 23:08 UTC

This package is auto-updated.

Last update: 2024-09-17 01:20:04 UTC


README

Latest Version on Packagist

Laravel CRUD 生成器是一个命令行工具,旨在简化为基于 Laravel 的 RESTful API 创建 CRUD(创建、读取、更新、删除)操作的过程。它自动化了动作、路由和资源的生成,让您可以快速设置端点以管理应用程序的数据模型。

安装

您可以通过 composer 安装此包

composer require mrcookie/simple-api-crud-generator

用法

php artisan api-crud:generate [App/Models/User or User or user]

然后您将获得这些路由和相关动作,以便您可以自定义所有内容以满足您的需求

Route::name('users.')->prefix('users')->group(function () {
    Route::get('', App\Api\Actions\Users\GetUsersAction::class);
    Route::get('{id}', App\Api\Actions\Users\ShowUserAction::class);
    Route::put('{id}', App\Api\Actions\Users\UpdateUserAction::class);
    Route::delete('{id}', App\Api\Actions\Users\DeleteUserAction::class);
});

我正在使用 "spatie/laravel-query-builder": "^5.3" 来处理查询和过滤。您可以查看 "spatie/laravel-query-builder": "^5.3" https://spatie.be/docs/laravel-query-builder/v5/introduction

您可以在您的模型中指定 allowedFiltersallowedFields

示例

class User extends Model {
    public static array $allowedFilters = [
        'name'
    ];
    
    public static array $allowedFields = [
        'name'
    ];
}

备注

Scramble 文档

visit [https://:8000/docs/api] to see the generated docs api routes

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请审查 我们的安全策略 以了解如何报告安全漏洞。

致谢

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。