mehedi8gb/api-crudify

自动化Laravel API的CRUD(创建、读取、更新、删除)操作。


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

概览

包名: Api CRUDify

描述

Api CRUDify是一个强大的Laravel包,旨在简化在Laravel应用程序中创建CRUD(创建、读取、更新、删除)操作的过程。使用Api CRUDify,您可以快速生成API控制器、模型、表单请求类、迁移等,让您能够专注于构建应用程序的核心功能,而不是编写重复的样板代码。

关键特性

  • 轻松生成CRUD:使用单个Artisan命令创建功能齐全的CRUD组件,减少开发时间和努力。

  • 可定制模板:Api CRUDify提供可定制的占位符模板,使您能够根据项目特定需求调整生成的代码。

  • 模型-控制器-路由集成:自动为控制器生成API路由,确保与Laravel应用程序的无缝集成。

  • 表单请求验证:通过自动生成存储和更新操作的表单请求类,简化输入验证。

  • 资源输出:生成资源和资源集合类,便于转换和格式化数据以供API响应使用。

  • 数据库迁移:自动为模型创建数据库迁移文件,帮助您轻松定义数据库模式。

  • 工厂集成:轻松将模型工厂集成到应用程序的种子器中,用于生成真实数据。

  • Laravel最佳实践:Api CRUDify遵循Laravel的最佳实践和编码标准,确保代码质量和可维护性。

安装

使用Composer在您的Laravel项目中安装Api CRUDify

composer require mehedi8gb/api-crudify --dev

用法

要使用Api CRUDify,请运行以下Artisan命令

php artisan crudify:make YourControllerName

要导出用于Postman的API模式,请运行以下Artisan命令

php artisan crudify:make YourControllerName --export-api-schema

运行命令后,Api CRUDify将生成以下文件

  • 控制器: app/Http/Controllers/YourControllerNameController.php
  • 模型: app/Models/YourControllerName.php
  • 表单请求: app/Http/Requests/YourControllerNameStoreRequest.php
  • 表单请求: app/Http/Requests/YourControllerNameUpdateRequest.php
  • 资源: app/Http/Resources/YourControllerNameResource.php
  • 资源集合: app/Http/Resources/YourControllerNameResourceCollection.php
  • 迁移: database/migrations/2021_01_01_000000_create_your_controller_names_table.php
  • 工厂: database/factories/YourControllerNameFactory.php
  • 种子器: database/seeders/YourControllerNameSeeder.php
  • 路由: routes/api.php

现在您可以运行以下命令来迁移数据库

php artisan migrate --seed

特性

您的请求将经过端到端的验证、加密和身份验证。您还可以导出用于Postman的API模式等。

变更日志

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

鸣谢

许可证

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