PHPackages                             alysontrizotto/laravel-ddl-crud - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. alysontrizotto/laravel-ddl-crud

ActiveLibrary[Framework](/categories/framework)

alysontrizotto/laravel-ddl-crud
===============================

Gerador de CRUD a partir de DDL (SQL) para Laravel 12.

0.1.2(9mo ago)0449↑100%[1 issues](https://github.com/AlysonTrizotto/laravel-ddl-crud/issues)MITPHPPHP >=8.2

Since Aug 14Pushed 9mo agoCompare

[ Source](https://github.com/AlysonTrizotto/laravel-ddl-crud)[ Packagist](https://packagist.org/packages/alysontrizotto/laravel-ddl-crud)[ RSS](/packages/alysontrizotto-laravel-ddl-crud/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (3)Versions (4)Used By (0)

Laravel DDL CRUD Generator
==========================

[](#laravel-ddl-crud-generator)

Gere um CRUD completo (Migration, Model, Service, Requests, Resource, Controller API, Factory e Testes) a partir de um arquivo DDL (.sql) no Laravel 12.

- Framework alvo: Laravel 12
- Stubs personalizáveis: `stubs/cascade/`
- Código organizado por geradores dedicados (SRP) e utilitários de suporte

Recursos
--------

[](#recursos)

- **Entrada via DDL**: lê múltiplas `CREATE TABLE` no mesmo arquivo
- **Geração completa**: migrations, models, services, requests, resources, controllers, factories, testes unit/feature
- **Stubs sobrescrevíveis**: personalize a estrutura gerada publicando os stubs
- **Heurísticas úteis**: mapeamento de tipos, inferência de `fillable`, `casts`, validações básicas
- **Separação de responsabilidades**: parsing, geração e escrita extraídos para classes dedicadas
- **Rotas automáticas**: gera rotas REST em `routes/api.php` com marcadores por domínio e idempotência (não duplica nem apaga rotas já existentes)

Sumário
-------

[](#sumário)

- [Pré-requisitos](#pr%C3%A9-requisitos)
- [Instalação](#instala%C3%A7%C3%A3o)
- [Publicar stubs (opcional)](#publicar-stubs-opcional)
- [Uso](#uso)
- [Exemplo de DDL suportada](#exemplo-de-ddl-suportada-postgres-like-ou-mysql-simples)
- [O que é gerado (por tabela)](#o-que-%C3%A9-gerado-por-tabela)
- [Rotas](#rotas)
- [Customização](#customiza%C3%A7%C3%A3o)
- [Testes](#testes)
- [Solução de problemas](#solu%C3%A7%C3%A3o-de-problemas)
- [Licença](#licen%C3%A7a)

Pré-requisitos
--------------

[](#pré-requisitos)

- PHP e extensões do Laravel 12
- Projeto Laravel instalado e funcional
- Arquivo DDL (.sql) com instruções `CREATE TABLE ... (...);`

Instalação
----------

[](#instalação)

Instale via Composer:

```
composer require alysontrizotto/laravel-ddl-crud
```

Este pacote suporta auto-discovery no Laravel. O service provider exposto é `AlysonTrizotto\DdlCrud\DdlCrudServiceProvider` (wrapper que aponta para `AlysonTrizotto\DdlCrud\Providers\DdlCrudServiceProvider`).

Publicar stubs (opcional)
-------------------------

[](#publicar-stubs-opcional)

Publique os stubs para customização no seu projeto (tag `stubs`):

```
php artisan vendor:publish --tag=stubs
```

Os stubs serão publicados em `stubs/cascade/` na raiz do projeto.

Stubs utilizados pelo gerador (se não existirem no projeto, um fallback interno será usado):

- `stubs/cascade/model.stub`
- `stubs/cascade/service.stub`
- `stubs/cascade/request.stub`
- `stubs/cascade/resource.stub`
- `stubs/cascade/controller.api.stub`
- `stubs/cascade/factory.stub`
- `stubs/cascade/unit.model.test.stub`
- `stubs/cascade/unit.service.test.stub`
- `stubs/cascade/feature.controller.test.stub`

Uso
---

[](#uso)

Você pode executar de duas formas:

1. Interativo (responder aos prompts):

```
php artisan make:crud-from-ddl
```

Prompts:

- Domínio (CamelCase) — exemplo: `Checklist` ou `Trip`.
- Caminho do arquivo DDL — exemplo: `D:/Alyson/ddl/checklist.sql`.

2. Direto por argumentos (sem prompts):

```
php artisan make:crud-from-ddl Checklist D:/Alyson/ddl/checklist.sql
```

Opções úteis:

- `--no-routes` — não gerar/adicionar rotas no `routes/api.php`.
- `--route-prefix=...` — adiciona `Route::prefix('...')->group(...)` envolvendo as rotas geradas (ex.: `--route-prefix=v1`).
- `--route-name=...` — define/override o slug da rota gerada (ex.: `--route-name=annotations`).
- `--middleware=a|b|c` — aplica middlewares na rota/agrupamento (ex.: `--middleware=auth:sanctum|throttle:60,1`).
- `--name-prefix=...` — prefixo de nomes de rotas (ex.: `--name-prefix=checklist.` → `checklist.photo-annotations.index`).
- `--only=a,b` — limita métodos do resource (ex.: `--only=index,show`).
- `--except=a,b` — exclui métodos do resource (ex.: `--except=destroy`).
- `--nested=...` — slug aninhado (ex.: `--nested=orders/{order}/items`).

Exemplo de DDL suportada (Postgres-like ou MySQL simples)
---------------------------------------------------------

[](#exemplo-de-ddl-suportada-postgres-like-ou-mysql-simples)

```
CREATE TABLE checklist.photo_annotations (
  id uuid primary key,
  checklist_id uuid not null,
  label varchar(150) not null,
  metadata jsonb,
  created_at timestamptz,
  updated_at timestamptz
);
```

O parser identifica o schema opcional (`checklist`), o nome da tabela (`photo_annotations`), colunas, tipos, nulos e chave primária.

O que é gerado (por tabela)
---------------------------

[](#o-que-é-gerado-por-tabela)

- Migration em `database/migrations/*_create_{schema_}{tabela}_table.php`
    - Cria schema (se informado) e a tabela com colunas mapeadas a partir da DDL
- Model em `app/Models/{Domínio}/{Model}.php`
    - `use HasFactory;`
    - `use SoftDeletes;` (apenas se a DDL contiver `deleted_at`)
    - `$table`, `$primaryKey`, `$incrementing`, `$keyType`
    - `$fillable` (exclui `created_at`, `updated_at`, `deleted_at`)
    - `$casts` (json/jsonb/arrays mapeados para `array`)
    - Métodos: `store(array $data)` e `applyUpdate(array $data)`
    - `scopeFilter(array $filters)`
- Service em `app/Services/{Domínio}/{Model}Service.php`
    - Focado em regra de negócio
    - Usa `Model::store`, `$model->applyUpdate`, `$model->delete()`
    - Métodos: `paginate`, `find`, `create`, `update`, `delete`
- Requests em `app/Http/Requests/{Domínio}/{Model}/`
    - `Store{Model}Request.php` e `Update{Model}Request.php`
    - Regras inferidas da DDL (required, tipos básicos, unique quando aplicável)
- Resource em `app/Http/Resources/{Domínio}/{Model}Resource.php`
    - Constrói a resposta padronizada com os campos da tabela
- Controller API em `app/Http/Controllers/API/{Domínio}/{Model}Controller.php`
    - Endpoints: `index`, `store`, `show`, `update`, `destroy`
    - Retorna `Resource` nas respostas
- Factory em `database/factories/{Domínio}/{Model}Factory.php`
    - Namespace: `Database\\Factories\\{Domínio}`
    - `$model` usando classe importada
    - PHPDoc `@extends Factory` usando nome curto
- Testes
    - Unit (Model): valida configuração do model
    - Unit (Service): cobre paginação e fluxo CRUD com asserts no banco
    - Feature (Controller): cobre CRUD completo via HTTP, status codes corretos, usa `apiResource`

Exemplo de execução
-------------------

[](#exemplo-de-execução)

```
php artisan make:crud-from-ddl
# Informe o domínio: Checklist
# Informe o caminho da DDL: D:/Alyson/sql/checklist_tables.sql
```

Arquivos esperados (exemplo `Checklist` + tabela `photo_annotations`):

- `database/migrations/2025_08_13_000000_create_checklist_photo_annotations_table.php`
- `app/Models/Checklist/PhotoAnnotation.php`
- `app/Services/Checklist/PhotoAnnotationService.php`
- `app/Http/Requests/Checklist/PhotoAnnotation/StorePhotoAnnotationRequest.php`
- `app/Http/Requests/Checklist/PhotoAnnotation/UpdatePhotoAnnotationRequest.php`
- `app/Http/Resources/Checklist/PhotoAnnotationResource.php`
- `app/Http/Controllers/API/Checklist/PhotoAnnotationController.php`

Rotas
-----

[](#rotas)

As rotas REST são adicionadas automaticamente ao arquivo `routes/api.php` com marcadores por domínio e lógica idempotente (não duplica rotas existentes e não apaga nada fora dos blocos do pacote).

Exemplo do que será inserido:

```
use Illuminate\Support\Facades\Route;

// BEGIN: DDL-CRUD routes [Checklist]
    Route::apiResource('photo-annotations', \App\Http\Controllers\API\Checklist\PhotoAnnotationController::class);
// END: DDL-CRUD routes [Checklist]
```

Com `--route-prefix=v1`:

```
// BEGIN: DDL-CRUD routes [Checklist]
    Route::prefix('v1')->group(function () {
        Route::apiResource('photo-annotations', \App\Http\Controllers\API\Checklist\PhotoAnnotationController::class);
    });
// END: DDL-CRUD routes [Checklist]
```

Notas:

- O slug da rota é derivado do nome da tabela (`photo_annotations` → `photo-annotations`).
- Se o arquivo `routes/api.php` não existir, ele será criado.
- Use `--no-routes` para pular a etapa de rotas.

### Exemplos de flags de rota

[](#exemplos-de-flags-de-rota)

- Somente leitura com prefixo e middlewares:

```
php artisan make:crud-from-ddl Checklist ddl.sql \
  --route-prefix=v1 \
  --middleware=auth:sanctum|throttle:60,1 \
  --only=index,show
```

- Nome de rota prefixado e slug customizado:

```
php artisan make:crud-from-ddl Checklist ddl.sql \
  --name-prefix=checklist. \
  --route-name=annotations
```

- Rota aninhada:

```
php artisan make:crud-from-ddl Orders ddl.sql --nested=orders/{order}/items
```

Observações:

- Para `--middleware`, separe múltiplos middlewares com `|` ou `;` (não use vírgulas, pois podem fazer parte de parâmetros como em `throttle:60,1`).
- Para `--nested`, informe o slug final desejado (com placeholders, se necessário). O gerador usa esse slug diretamente no `apiResource`.

### Remoção de rotas (segura por domínio)

[](#remoção-de-rotas-segura-por-domínio)

Para remover o bloco de rotas gerado para um domínio (entre `BEGIN/END`), use:

```
php artisan ddl-crud:routes:remove Checklist
```

Esse comando remove apenas o bloco do domínio informado, preservando o restante de `routes/api.php`.

Customização
------------

[](#customização)

Edite os stubs em `stubs/cascade/` para moldar o padrão do seu projeto:

- Adicionar/remover campos na resposta do `Resource`
- Ajustar validações nos `Requests`
- Adaptar `Service` para suas regras de negócio
- Evoluir o `Model` (relations, mutators, etc.)

Observações
-----------

[](#observações)

- O comando valida domínio (CamelCase) e lê múltiplas tabelas no mesmo arquivo DDL.
- Para tipos não suportados no Schema do Laravel, o gerador faz fallback para `string(36)` (ex.: uuid) e outros mapeamentos simples.
- Caso você utilize MySQL, ajuste os tipos/timezones nas DDLs conforme o seu banco.
- Fábricas são geradas por domínio: `database/factories/{Domínio}/{Model}Factory.php`. Isso permite ao Laravel resolver automaticamente a factory de models namespaced.
- O Controller usa vinculação de rota por nome de parâmetro; exemplo: para `PhotoAnnotationController`, as assinaturas são `show(PhotoAnnotation $photoAnnotation)`, `update(PhotoAnnotation $photoAnnotation, ...)`, `destroy(PhotoAnnotation $photoAnnotation)`.
- Em SQLite, colunas JSON podem ser persistidas como texto. Os testes gerados evitam comparar diretamente campos JSON com `assertDatabaseHas` para prevenir falsos negativos.
- Para `SoftDeletes`, inclua `deleted_at` na DDL para o gerador adicionar o trait ao Model e os asserts de soft delete aos testes. Caso seu schema inicial não tenha `deleted_at`, crie uma migration complementar adicionando `softDeletes()`.

Testes
------

[](#testes)

- Configure `.env.testing` e rode as migrations de teste.
- Execute a suíte: `php artisan test`.

---

Se precisar, abra uma issue ou peça para ajustar os stubs para novas regras do seu domínio.

Problemas comuns
----------------

[](#problemas-comuns)

- "Command cannot have an empty name": confira a assinatura do comando `make:crud-from-ddl` em `app/Console/Commands/MakeCrudFromDdl.php`.
- Arquivo DDL inválido: certifique-se de terminar cada `CREATE TABLE ... (...);` com `;` e usar sintaxe consistente.

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance58

Moderate activity, may be stable

Popularity17

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

270d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/727fe0adfda0e8e3347e1c5da44db40d9376ce95115bf27933491e70ca2fa007?d=identicon)[AlysonTrizotto](/maintainers/AlysonTrizotto)

---

Top Contributors

[![AlysonTrizotto](https://avatars.githubusercontent.com/u/79091765?v=4)](https://github.com/AlysonTrizotto "AlysonTrizotto (45 commits)")

### Embed Badge

![Health badge](/badges/alysontrizotto-laravel-ddl-crud/health.svg)

```
[![Health](https://phpackages.com/badges/alysontrizotto-laravel-ddl-crud/health.svg)](https://phpackages.com/packages/alysontrizotto-laravel-ddl-crud)
```

###  Alternatives

[laravel/ui

Laravel UI utilities and presets.

2.7k134.9M601](/packages/laravel-ui)[laravel/breeze

Minimal Laravel authentication scaffolding with Blade and Tailwind.

3.0k31.3M148](/packages/laravel-breeze)[laravel/passport

Laravel Passport provides OAuth2 server support to Laravel.

3.4k85.0M532](/packages/laravel-passport)[laravel/sail

Docker files for running a basic Laravel application.

1.9k186.9M1.0k](/packages/laravel-sail)[laravel/wayfinder

Generate TypeScript representations of your Laravel actions and routes.

1.7k4.1M69](/packages/laravel-wayfinder)[laravel/jetstream

Tailwind scaffolding for the Laravel framework.

4.1k19.8M136](/packages/laravel-jetstream)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)