dotnet aspnet-codegenerator

  • Article

Par Rick Anderson

dotnet aspnet-codegenerator - Exécute le moteur de génération de modèles automatique ASP.NET Core. dotnet aspnet-codegenerator étant uniquement requis pour générer automatiquement des modèles à partir de la ligne de commande, il n’est pas nécessaire d’utiliser la génération de modèles automatique avec Visual Studio.

Installer et mettre à jour aspnet-codegenerator

Installez le Kit de développement logiciel (SDK) pour .NET.

dotnet aspnet-codegenerator est un outil global qui doit être installé. La commande suivante installe la dernière version stable de l’outil dotnet aspnet-codegenerator :

dotnet tool install -g dotnet-aspnet-codegenerator

Remarque

Par défaut, l’architecture des fichiers binaires .NET à installer représente l’architecture du système d’exploitation en cours d’exécution. Pour spécifier une architecture de système d’exploitation différente, consultez dotnet tool install, --arch option. Pour plus d'informations, consultez le problème GitHub dotnet/AspNetCore.Docs n° 29262.

La commande suivante met à jour dotnet aspnet-codegenerator vers la dernière version stable disponible à partir du SDK .NET Core installé :

dotnet tool update -g dotnet-aspnet-codegenerator

Désinstaller aspnet-codegenerator

Il peut être nécessaire de désinstaller le aspnet-codegenerator pour résoudre les problèmes. Par exemple, si vous avez installé une version préliminaire de aspnet-codegenerator, désinstallez-la avant d’installer la version publiée.

La commande suivante désinstalle l’outil dotnet aspnet-codegenerator et installe la dernière version stable :

dotnet tool uninstall -g dotnet-aspnet-codegenerator
dotnet tool install -g dotnet-aspnet-codegenerator

Synopsis

dotnet aspnet-codegenerator [arguments] [-p|--project] [-n|--nuget-package-dir] [-c|--configuration] [-tfm|--target-framework] [-b|--build-base-path] [--no-build] 
dotnet aspnet-codegenerator [-h|--help]

Description

La commande globale dotnet aspnet-codegenerator exécute le générateur de code ASP.NET Core et le moteur de génération de modèles automatique.

Arguments

generator

Le générateur de code à effectuer. Les générateurs suivants sont disponibles :

Générateur Opération
area Génération de modèles automatique pour une zone
contrôleur Génération de modèles automatique pour un contrôleur
identity Génère automatiquement des modèles Identity
razorpage Génère automatiquement des modèles Razor Pages
view Génération de modèles automatique pour une vue

Options

-n|--nuget-package-dir

Spécifie le répertoire du package NuGet.

-c|--configuration {Debug|Release}

Définit la configuration de build. La valeur par défaut est Debug.

-tfm|--target-framework

Framework cible à utiliser. Par exemple, net46

-b|--build-base-path

Le chemin de base de génération.

-h|--help

Affiche une aide brève pour la commande.

--no-build

Ne génère pas le projet avant l’exécution. L’indicateur --no-restore est également défini implicitement.

-p|--project <PATH>

Spécifie le chemin du fichier projet à exécuter (nom de dossier ou chemin complet). Si aucune valeur n’est spécifiée, le répertoire actif est utilisé par défaut.

Options du générateur

Les sections suivantes décrivent en détail les options disponibles pour les générateurs pris en charge :

  • Zone
  • Contrôleur
  • Identity
  • Razorpage
  • Afficher

Options de zone

Cet outil est conçu pour les projets web ASP.NET Core avec des contrôleurs et des vues. Elle n’est pas destinée aux applications Razor Pages.

Utilisation : dotnet aspnet-codegenerator area AreaNameToGenerate

La commande précédente génère les dossiers suivants :

  • Zones (Areas)
    • AreaNameToGenerate
      • Contrôleurs
      • Données
      • Modèles
      • Views

Options de contrôleur

Le tableau ci-dessous répertorie les options pour aspnet-codegeneratorrazorpage, controller et view :

Option Description
--model ou -m Classe de modèle à utiliser.
--dataContext ou -dc Classe DbContext à utiliser ou nom de la classe à générer.
--bootstrapVersion ou -b Spécifie la version de démarrage. Les valeurs valides sont 3 ou 4. La valeur par défaut est 4. S’il est nécessaire mais absent, un répertoire wwwroot est créé, qui comprend les fichiers de démarrage de la version spécifiée.
--referenceScriptLibraries ou -scripts Référence les bibliothèques de scripts dans les vues générées. Ajoute _ValidationScriptsPartial aux pages Modifier et Créer.
--layout ou -l Page de disposition personnalisée à utiliser.
--useDefaultLayout ou -udl Utiliser la disposition par défaut pour les vues.
--force ou -f Remplacer les fichiers existants.
--relativeFolderPath ou -outDir Spécifiez le chemin du dossier de sortie relatif à partir du projet où le fichier doit être généré. S’il n’est pas spécifié, le fichier sera généré dans le dossier du projet
--useSqlite ou -sqlite Marquez d’un drapeau pour spécifier si DbContext doit utiliser SQLite au lieu de SQL Server.

Le tableau ci-dessous répertorie les options uniques à aspnet-codegenerator controller :

Option Description
--controllerName ou -name Nom du contrôleur.
--useAsyncActions ou -async Générer des actions asynchrones du contrôleur.
--noViews ou -nv Ne générer aucune vue.
--restWithNoViews ou -api Générer un contrôleur avec l’API de style REST. noViews est supposé et les options associées à la vue sont ignorées.
--readWriteActions ou -actions Générer un contrôleur avec actions en lecture/écriture sans modèle.

Utilisez le commutateur -h pour obtenir de l’aide sur la commande aspnet-codegenerator controller :

dotnet aspnet-codegenerator controller -h

Consultez Générer automatiquement le modèle de film pour obtenir un exemple de dotnet aspnet-codegenerator controller.

Razorpage

Razor Pages peut être structuré individuellement en spécifiant le nom de la nouvelle page et le modèle à utiliser. Les modèles pris en charge sont :

  • Empty
  • Create
  • Edit
  • Delete
  • Details
  • List

Par exemple, la commande suivante utilise le modèle de modification pour générer MyEdit.cshtml et MyEdit.cshtml.cs :

dotnet aspnet-codegenerator razorpage MyEdit Edit -m Movie -dc RazorPagesMovieContext -outDir Pages/Movies

En règle générale, le modèle et le nom de fichier générés ne sont pas spécifiés, et les modèles suivants sont créés :

  • Create
  • Edit
  • Delete
  • Details
  • List

Le tableau ci-dessous répertorie les options pour aspnet-codegeneratorrazorpage, controller et view :

Option Description
--model ou -m Classe de modèle à utiliser.
--dataContext ou -dc Classe DbContext à utiliser ou nom de la classe à générer.
--bootstrapVersion ou -b Spécifie la version de démarrage. Les valeurs valides sont 3 ou 4. La valeur par défaut est 4. S’il est nécessaire mais absent, un répertoire wwwroot est créé, qui comprend les fichiers de démarrage de la version spécifiée.
--referenceScriptLibraries ou -scripts Référence les bibliothèques de scripts dans les vues générées. Ajoute _ValidationScriptsPartial aux pages Modifier et Créer.
--layout ou -l Page de disposition personnalisée à utiliser.
--useDefaultLayout ou -udl Utiliser la disposition par défaut pour les vues.
--force ou -f Remplacer les fichiers existants.
--relativeFolderPath ou -outDir Spécifiez le chemin du dossier de sortie relatif à partir du projet où le fichier doit être généré. S’il n’est pas spécifié, le fichier sera généré dans le dossier du projet
--useSqlite ou -sqlite Marquez d’un drapeau pour spécifier si DbContext doit utiliser SQLite au lieu de SQL Server.

Le tableau ci-dessous répertorie les options uniques à aspnet-codegenerator razorpage :

Option Description
--namespaceName ou -namespace Nom de l’espace de noms à utiliser pour le PageModel généré
--partialView ou -partial Générer une vue partielle. Les options de mise en page -l et -udl sont ignorées si ceci est spécifié.
--noPageModel ou -npm Choisir de ne pas générer une classe PageModel pour le modèle vide

Utilisez le commutateur -h pour obtenir de l’aide sur la commande aspnet-codegenerator razorpage :

dotnet aspnet-codegenerator razorpage -h

Consultez Générer automatiquement le modèle de film pour obtenir un exemple de dotnet aspnet-codegenerator razorpage.

Afficher

Les vues peuvent être structurées individuellement en spécifiant le nom de la vue et le modèle à utiliser. Les modèles pris en charge sont :

  • Empty
  • Create
  • Edit
  • Delete
  • Details
  • List

Par exemple, la commande suivante utilise le modèle de modification pour générer MyEdit.cshtml :

dotnet aspnet-codegenerator view MyEdit Edit -m Movie -dc MovieContext -outDir Views/Movies

Le tableau ci-dessous répertorie les options pour aspnet-codegeneratorrazorpage, controller et view :

Option Description
--model ou -m Classe de modèle à utiliser.
--dataContext ou -dc Classe DbContext à utiliser ou nom de la classe à générer.
--bootstrapVersion ou -b Spécifie la version de démarrage. Les valeurs valides sont 3 ou 4. La valeur par défaut est 4. S’il est nécessaire mais absent, un répertoire wwwroot est créé, qui comprend les fichiers de démarrage de la version spécifiée.
--referenceScriptLibraries ou -scripts Référence les bibliothèques de scripts dans les vues générées. Ajoute _ValidationScriptsPartial aux pages Modifier et Créer.
--layout ou -l Page de disposition personnalisée à utiliser.
--useDefaultLayout ou -udl Utiliser la disposition par défaut pour les vues.
--force ou -f Remplacer les fichiers existants.
--relativeFolderPath ou -outDir Spécifiez le chemin du dossier de sortie relatif à partir du projet où le fichier doit être généré. S’il n’est pas spécifié, le fichier sera généré dans le dossier du projet
--useSqlite ou -sqlite Marquez d’un drapeau pour spécifier si DbContext doit utiliser SQLite au lieu de SQL Server.

Le tableau ci-dessous répertorie les options uniques à aspnet-codegenerator view :

Option Description
--controllerNamespace ou -namespace Spécifier le nom de l’espace de noms à utiliser pour le contrôleur généré
--partialView ou -partial Générer une vue partielle, d’autres options de disposition (-l et -udl) sont ignorées si cela est spécifié

Utilisez le commutateur -h pour obtenir de l’aide sur la commande aspnet-codegenerator view :

dotnet aspnet-codegenerator view -h

Identity

Voir Générer automatiquement des modèles Identity