ventom/flutter-api-package

一个用于整合Flutter应用API的包。

v1.0.0 2024-08-27 05:13 UTC

This package is auto-updated.

Last update: 2024-09-27 05:32:57 UTC


README

概览

MakeFlutterCommand 包为Laravel项目中的Flutter组件提供 artisan 命令,用于生成必要的文件和结构。此命令通过自动创建必要的资源、迁移、模型、控制器和路由,遵循Laravel的最佳实践,简化了开发过程。

安装

1. 需求包

要开始使用,您需要使用 Composer 在 Laravel 项目中要求该包

composer require ventom/make-flutter-command

2. 服务提供者(如果未自动发现)

如果 ventom 包未由 Laravel 自动发现,则需要手动注册服务提供者。打开 config/app.php 文件,并将服务提供者添加到 providers 数组

'providers' => [
    // Other Service Providers

    Vendor\Package\FlutterServiceProvider::class,
]

3. 发布配置(可选)

如果您的包包含需要发布到 Laravel 应用程序配置目录的配置文件,您可以使用以下命令发布它们

php artisan vendor:publish --provider="Vendor\Package\FlutterServiceProvider"

用法

创建Flutter组件

您可以使用以下 artisan 命令生成 Flutter 组件

    php artisan make:flutter {name} {--seeder}
  • {name}:您要创建的组件名称。
  • --seeder:(可选) 如果提供此选项,则还会生成一个 seeder 文件。

示例

要创建名为 "Product" 的 Flutter 组件并包含 seeder,请使用以下命令

    php artisan make:flutter Product --seeder

此命令将创建以下文件并更新

  1. 资源app/Http/Resources/ProductResource.php
  2. 迁移database/migrations/xxxx_xx_xx_create_products_table.php
  3. 辅助程序app/Helpers/ProductHelper.php
  4. 模型app/Models/Product.php
  5. 控制器app/Http/Controllers/Api/ProductController.php
  6. 路由:在 routes/api.php 中添加 RESTful API 路由
  7. seeder:(如果提供 --seeder) database/seeders/ProductSeeder.php

生成的控制器操作

该包创建了一个具有以下操作的控制器

  • json():获取模型的所有实例并作为 JSON 响应返回它们。
  • show($id):通过其 ID 获取特定实例。
  • store(Request $request):在数据库中存储新实例。
  • update(Request $request, $id):通过其 ID 更新现有实例。
  • destroy($id):通过其 ID 删除实例。

生成的API路由

生成的路由可以在 routes/api.php 中找到,包括

Route::prefix('products')
    ->controller(App\Http\Controllers\Api\ProductController::class)
    ->group(function () {
        Route::get('/json', 'json');
        Route::get('/{id}', 'show');
        Route::post('/', 'store');
        Route::put('/{id}', 'update');
        Route::delete('/{id}', 'destroy');
    });

变更日志

此项目的所有重大更改都将在此部分中记录。

贡献

如果您想贡献,请将存储库分支并使用功能分支。欢迎拉取请求。

许可

此包是开源软件,许可协议为 MIT 许可证