README

用于在 Laravel 中创建 API 的工具包。

安装

您可以通过 composer 安装此包

composer require juststeveking/laravel-api-toolkit

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="JustSteveKing\Laravel\ApiToolkit\ApiToolkitServiceProvider" --tag="config"

这是发布配置文件的内容

return [
    'resource_name' => '%sResource',
    'policy_name' => '%sPolicy',
    'seeder_name' => '%sSeeder',
    'controllers' => [
        [
            'name' => 'IndexController',
            'options' => [
                '--invokable',
            ]
        ],
        [
            'name' => 'CreateController',
            'options' => [
                '--invokable',
            ]
        ],
        [
            'name' => 'ShowController',
            'options' => [
                '--invokable',
            ]
        ],
        [
            'name' => 'UpdateController',
            'options' => [
                '--invokable',
            ]
        ],
        [
            'name' => 'DeleteController',
            'options' => [
                '--invokable',
            ]
        ],
    ],
    'form_requests' => [
        'CreateRequest',
        'UpdateRequest',
    ],
];

使用方法

要开始使用此工具，您只需关注一个命令： api-toolkit:resource。

您需要传递给该命令的唯一选项是您希望创建 API 蓝图的 Eloquent 模型。

php artisan api-toolkit:resource Post

上述命令将生成以下内容

• app/Models/Post.php
• app/Policies/PostPolicy.php - 类名可以在配置中更改
• app/Http/Resources/PostResource.php - 类名可以在配置中更改
• app/Http/Requests/Api/Post/CreateRequest.php - 类名可以在配置中更改
• app/Http/Requests/Api/Post/UpdateRequest.php - 类名可以在配置中更改
• app/Http/Controllers/Post/IndexController.php - 类名可以在配置中更改
• app/Http/Controllers/Post/CreateController.php - 类名可以在配置中更改
• app/Http/Controllers/Post/ShowController.php - 类名可以在配置中更改
• app/Http/Controllers/Post/UpdateController.php - 类名可以在配置中更改
• app/Http/Controllers/Post/DeleteController.php - 类名可以在配置中更改
• database/seeds/PostSeeder.php - 类名可以在配置中更改
• database/factories/PostFactory.php
• database/migrations/xxxx_xx_xx_xxxxxx_create_posts_table.php

测试

composer test

变更日志

请查看 CHANGELOG 以获取有关最近更改的更多信息。

贡献

请查看 CONTRIBUTING 以获取详细信息。

安全漏洞

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

致谢

• Steve McDougall
• 所有贡献者

许可

MIT 许可证 (MIT)。有关更多信息，请参阅 许可文件。