microprefix / crud-generator
一个用于从现有模型和迁移生成API资源的Laravel包。
Requires
- php: ^7.3||^8.0
- doctrine/dbal: >=3.0
- doctrine/inflector: >=2.0
- illuminate/console: >=8.0
- illuminate/routing: >=8.0
- illuminate/support: >=8.0
Requires (Dev)
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-09-09 15:31:33 UTC
README
Laravel CRUD生成器包是一个用于生成Laravel应用程序API资源的工具。使用此包,您可以轻松地为现有模型和迁移创建控制器、请求和路由。非常适合快速原型设计和开发。它使用Swagger注解来生成API资源的OpenAPI模式。
可以在配置文件中禁用Swagger注解。
安装
您可以通过Composer安装此包
composer require microprefix/crud-generator
安装包后,您需要将服务提供者添加到您的config/app.php文件中
'providers' => [ // ... Microprefix\CrudGenerator\CrudGeneratorServiceProvider::class, ];
使用方法
您可以通过运行以下命令生成资源
php artisan crud:api Post
此命令将为Test模型生成控制器、请求和路由。默认情况下,控制器和请求将分别放置在app/Http/Controllers和app/Http/Requests目录中。
- app/Http/Controllers/PostController.php
- app/Http/Requests/PostRequest.php
- routes/api.php
- database/migrations/2019_01_01_000000_create_posts_table.php
您可以通过在包的配置文件(config/crud-generator.php)中设置controller_path和request_path选项来自定义生成的文件路径。您还可以通过在配置文件中设置use_swagger选项来启用或禁用为生成的API资源启用Swagger注解。
要基于其迁移文件更新模型的OpenAPI模式,您可以使用crud:schema Artisan命令
php artisan crud:schema Post
此命令将根据迁移文件中定义的字段更新Post模型的OpenAPI模式。您可以通过在包的配置文件(config/crud-generator.php)中设置schema_path选项来自定义模式文件的路径。
配置
您可以使用以下命令发布配置文件
php artisan vendor:publish --provider="Microprefix\CrudGenerator\CrudGeneratorServiceProvider" --tag="config"
致谢
此包受DarkaOnLine/L5-Swagger包的启发,以及我的好朋友Milaim Ajdari。
许可证
Laravel CRUD生成器包是开源软件,许可协议为MIT。
此README文件提供了对包的概述,包括安装和使用说明,以及致谢和许可证信息。您可以根据自己的需求自定义此文件,并在必要时添加其他部分。