programmeruz / laravel-creator
使用简单表单生成模型、迁移、播种器、工厂、资源、控制器、SWAGGER
v1.1.1
2023-09-19 15:37 UTC
Requires
- darkaonline/l5-swagger: ^8.5
README
Laravel Creator 是一个用于简化 Laravel 项目代码生成过程的包。在 /creator 端点,您可以通过直观的 UI 容易地生成迁移、播种器、模型、控制器和 API 资源,并支持内置的 Swagger 文档。
安装
通过 Composer 安装
首先,使用 Composer 引入此包
composer require programmeruz/laravel-creator
注册服务提供者(适用于低于 5.5 版本的 Laravel)
安装后,如果您正在运行低于 5.5 版本的 Laravel,您需要注册服务提供者。打开 config/app.php 并将服务提供者添加到 providers 数组中
'providers' => [
// ...
Programmeruz\LaravelCreator\LaravelCreatorServiceProvider::class,
],
注意:Laravel 5.5 及以上版本使用包自动发现,因此不需要手动添加 ServiceProvider。
访问 Creator UI
一旦包正确安装并且服务提供者已注册,导航到
your-laravel-app-url/creator
在这里,您将找到直观的 UI,它会引导您完成代码生成过程。
使用 Swagger 文档
为了使用 Swagger,不要忘记在主控制器类中添加 @OA\Info
/**
* @OA\Info(
* version="1.0",
* title="Example for response examples value"
* )
*/
class Controller extends BaseController
{
use AuthorizesRequests, ValidatesRequests;
}
要利用 Swagger 功能,在设置好路由和控制器后,运行以下命令
php artisan l5-swagger:generate
这将生成必要的 Swagger 配置和 UI,您通常可以在
your-laravel-app-url/api/documentation
结语
Laravel Creator 被设计用来提升您的开发工作流程,确保您花更多的时间在构建应用程序的独特功能上,而不是在样板代码上。如果您遇到任何问题或需要支持,请在我们 GitHub 仓库中提出问题。
编码愉快!
此文档提供了对您的包的结构化介绍,引导用户了解安装和基本使用过程。您可以通过包括高级功能、贡献指南或任何其他相关信息来进一步扩展它。