Skip to content

Référence CLI

Commandes

bash
php artisan make:fullapi {name?} {--fields=} {--soft-deletes} {--postman} {--auth} {--interactive} {--only=}
                         {--schema=} {--mermaid=} {--from-database} {--tables=} {--with-migrations} {--query-builder}
                         {--pest} {--json-api} {--add-fields=}
php artisan delete:fullapi {name?} {--force}
php artisan api-generator:clean-routes {--dry-run}
php artisan api-generator:introspect {--table=}
php artisan api-generator:validate-stubs {--json}
php artisan api-generator:install

make:fullapi

Argument / OptionDescription
nameNom de l'entité (PascalCase). Omettre pour le mode schéma / JSON.
--fieldsDéfinitions de champs au format nom:type, séparées par des virgules. enum(a,b) et :primary supportés.
--soft-deletesTrait SoftDeletes, colonne de migration, endpoints restore/forceDelete.
--postmanExporte une collection Postman v2.1 après génération.
--authGénère l'authentification Sanctum (AuthController, requests, routes, middleware).
--interactiveLance l'assistant pas à pas de création d'entité.
--only=Type,TypeRégénère uniquement les artefacts listés ; ignore route + seeder.
--schema=fichierGénère toutes les entités depuis un schéma YAML/JSON déclaratif.
--mermaid=fichierGénère toutes les entités depuis un erDiagram / classDiagram Mermaid.
--from-databaseIntrospecte la base existante et génère les APIs de ses tables.
--tables=a,bRestreint --from-database à certaines tables.
--with-migrationsAvec --from-database : génère aussi les fichiers de migration.
--query-builderUtilise spatie/laravel-query-builder pour le filtrage et le tri de l'index.
--pestGénère des tests Pest au lieu de PHPUnit.
--json-apiGénère des resources conformes à JSON:API (JsonApiResource, Laravel 12.45+). Repli sur une resource standard sur les versions antérieures.
--add-fields=a:type,b:typeAjoute des champs à une entité existante : migration incrémentale + patchs en place.

Types pour --only : Model, Controller, Service, DTO, Request, Resource, Migration, Factory, Seeder, Policy, FeatureTest, UnitTest.

delete:fullapi

Argument / OptionDescription
nameEntité à supprimer. Omettre pour supprimer toutes les entités de class_data.json.
--forcePasse la demande de confirmation.

Supprime tous les fichiers générés, désenregistre le seeder, et retire les routes de l'entité de routes/api.php et routes/web.php.

api-generator:clean-routes

Supprime les routes pointant vers des contrôleurs qui n'existent plus (répare la ReflectionException de route:list après des suppressions manuelles).

OptionDescription
--dry-runListe les lignes orphelines sans toucher aux fichiers.

api-generator:introspect

Émet le schéma de la base du projet en JSON pour l'outillage.

OptionDescription
(aucune)Liste toutes les tables utilisateur (tables système filtrées).
--table=nomDécrit une table : noms de colonnes, types normalisés, flag soft-deletes.

api-generator:validate-stubs

Vérifie que les stubs publiés contiennent toujours chaque requis.

OptionDescription
--jsonSortie lisible machine ; code de sortie 1 en cas d'erreur (pour la CI).

api-generator:install

Installe et configure le package et ses dépendances optionnelles de façon interactive.