dotnet aspnet-codegeneratordotnet aspnet-codegenerator

De Rick AndersonBy Rick Anderson

dotnet aspnet-codegenerator - Exécute le moteur de génération de modèles automatique ASP.NET Core.dotnet aspnet-codegenerator - Runs the ASP.NET Core scaffolding engine. 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.dotnet aspnet-codegenerator is only required to scaffold from the command line, it's not needed to use scaffolding with Visual Studio.

Cet article s’applique au SDK .NET Core 2.1 et ultérieur.This article applies to .NET Core 2.1 SDK and later.

Installation d’aspnet-codegeneratorInstalling aspnet-codegenerator

dotnet-aspnet-codegenerator est un outil global qui doit être installé.dotnet-aspnet-codegenerator is a global tool that must be installed. La commande suivante installe la dernière version stable de l’outil dotnet-aspnet-codegenerator :The following command installs the latest stable version of the dotnet-aspnet-codegenerator tool:

dotnet tool install -g dotnet-aspnet-codegenerator

La commande suivante met à jour dotnet-aspnet-codegenerator vers la dernière version stable disponible à partir du SDK .NET Core installé :The following command updates dotnet-aspnet-codegenerator to the latest stable version available from the installed .NET Core SDKs:

dotnet tool update -g dotnet-aspnet-codegenerator

SynopsisSynopsis

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]

DescriptionDescription

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.The dotnet aspnet-codegenerator global command runs the ASP.NET Core code generator and scaffolding engine.

ArgumentsArguments

generator

Le générateur de code à effectuer.The code generator to run. Les générateurs suivants sont disponibles :The following generators are available:

GénérateurGenerator OpérationOperation
superficiearea Génération de modèles automatique pour une zoneScaffolds an Area
contrôleurcontroller Génération de modèles automatique pour un contrôleurScaffolds a controller
identitéidentity Génération de modèles automatique pour une identitéScaffolds Identity
razorpagerazorpage Génération de modèles automatique pour Razor PagesScaffolds Razor Pages
vueview Génération de modèles automatique pour une vueScaffolds a view

OptionsOptions

-n|--nuget-package-dir

Spécifie le répertoire du package NuGet.Specifies the NuGet package directory.

-c|--configuration {Debug|Release}

Définit la configuration de build.Defines the build configuration. La valeur par défaut est Debug.The default value is Debug.

-tfm|--target-framework

Framework cible à utiliser.Target Framework to use. Par exemple : net46.For example, net46.

-b|--build-base-path

Le chemin de base de génération.The build base path.

-h|--help

Affiche une aide brève pour la commande.Prints out a short help for the command.

--no-build

Ne génère pas le projet avant l’exécution.Doesn't build the project before running. L’indicateur --no-restore est également défini implicitement.It also implicitly sets the --no-restore flag.

-p|--project <PATH>

Spécifie le chemin du fichier projet à exécuter (nom de dossier ou chemin complet).Specifies the path of the project file to run (folder name or full path). Si aucune valeur n’est spécifiée, le répertoire actif est utilisé par défaut.If not specified, it defaults to the current directory.

Options du générateurGenerator options

Les sections suivantes décrivent en détail les options disponibles pour les générateurs pris en charge :The following sections detail the options available for the supported generators:

  • DomaineArea
  • ContrôleurController
  • IdentitéIdentity
  • RazorpageRazorpage
  • AffichageView

Options de zoneArea options

Cet outil est conçu pour les projets web ASP.NET Core avec des contrôleurs et des vues.This tool is intended for ASP.NET Core web projects with controllers and views. Il n’est pas destinée aux applications Razor Pages.It's not intended for Razor Pages apps.

Utilisation : dotnet aspnet-codegenerator area AreaNameToGenerateUsage: dotnet aspnet-codegenerator area AreaNameToGenerate

La commande précédente génère les dossiers suivants :The preceding command generates the following folders:

  • ZonesAreas
    • AreaNameToGenerateAreaNameToGenerate
      • ContrôleursControllers
      • DonnéesData
      • ModèlesModels
      • ViewsViews

Options de contrôleurController options

Le tableau suivant répertorie les options de aspnet-codegenerator controller et razorpage:The following table lists options for aspnet-codegenerator controller and razorpage:

OptionOption DescriptionDescription
--model ou -m--model or -m Classe de modèle à utiliser.Model class to use.
--dataContext ou -dc--dataContext or -dc Classe DbContext à utiliser.The DbContext class to use.
--bootstrapVersion ou -b--bootstrapVersion or -b Spécifie la version de démarrage.Specifies the bootstrap version. Les valeurs valides sont 3 ou 4.Valid values are 3 or 4. La valeur par défaut est 4.Default is 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.If needed and not present, a wwwroot directory is created that includes the bootstrap files of the specified version.
--referenceScriptLibraries ou -scripts--referenceScriptLibraries or -scripts Référence les bibliothèques de scripts dans les vues générées.Reference script libraries in the generated views. Ajoute _ValidationScriptsPartial aux pages Modifier et Créer.Adds _ValidationScriptsPartial to Edit and Create pages.
--layout ou -l--layout or -l Page de disposition personnalisée à utiliser.Custom Layout page to use.
--useDefaultLayout ou -udl--useDefaultLayout or -udl Utiliser la disposition par défaut pour les vues.Use the default layout for the views.
--force ou -f--force or -f Remplacer les fichiers existants.Overwrite existing files.
--relativeFolderPath ou -outDir--relativeFolderPath or -outDir Chemin relatif du dossier de sortie du projet où les fichiers sont générés.The relative output folder path from project where the file are generated. S’il n’est pas spécifié, les fichiers sont générés dans le dossier du projet.If not specified, files are generated in the project folder.

Le tableau ci-dessous répertorie les options uniques à aspnet-codegenerator controller :The following table lists options unique to aspnet-codegenerator controller:

OptionOption DescriptionDescription
--controllerName ou -name--controllerName or -name Nom du contrôleur.Name of the controller.
--useAsyncActions ou -async--useAsyncActions or -async Générer des actions asynchrones du contrôleur.Generate async controller actions.
--noViews ou -nv--noViews or -nv Ne générer aucune vue.Generate no views.
--restWithNoViews ou -api--restWithNoViews or -api Générer un contrôleur avec l’API de style REST.Generate a Controller with REST style API. noViews est supposé et les options associées à la vue sont ignorées.noViews is assumed and any view related options are ignored.
--readWriteActions ou -actions--readWriteActions or -actions Générer un contrôleur avec actions en lecture/écriture sans modèle.Generate controller with read/write actions without a model.

Utilisez le commutateur -h pour obtenir de l’aide sur la commande aspnet-codegenerator controller :Use the -h switch for help on the aspnet-codegenerator controller command:

dotnet aspnet-codegenerator controller -h

Consultez Générer automatiquement le modèle de film pour obtenir un exemple de dotnet aspnet-codegenerator controller.See Scaffold the movie model for an example of dotnet aspnet-codegenerator controller.

RazorpageRazorpage

Les Razor Pages peuvent être structurées individuellement en spécifiant le nom de la nouvelle page et le modèle à utiliser.Razor Pages can be individually scaffolded by specifying the name of the new page and the template to use. Les modèles pris en charge sont :The supported templates are:

  • 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 :For example, the following command uses the Edit template to generate MyEdit.cshtml and 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 :Typically, the template and generated file name is not specified, and the following templates are created:

  • Create
  • Edit
  • Delete
  • Details
  • List

Le tableau suivant répertorie les options de aspnet-codegenerator razorpage et controller:The following table lists options for aspnet-codegenerator razorpage and controller:

OptionOption DescriptionDescription
--model ou -m--model or -m Classe de modèle à utiliser.Model class to use.
--dataContext ou -dc--dataContext or -dc Classe DbContext à utiliser.The DbContext class to use.
--bootstrapVersion ou -b--bootstrapVersion or -b Spécifie la version de démarrage.Specifies the bootstrap version. Les valeurs valides sont 3 ou 4.Valid values are 3 or 4. La valeur par défaut est 4.Default is 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.If needed and not present, a wwwroot directory is created that includes the bootstrap files of the specified version.
--referenceScriptLibraries ou -scripts--referenceScriptLibraries or -scripts Référence les bibliothèques de scripts dans les vues générées.Reference script libraries in the generated views. Ajoute _ValidationScriptsPartial aux pages Modifier et Créer.Adds _ValidationScriptsPartial to Edit and Create pages.
--layout ou -l--layout or -l Page de disposition personnalisée à utiliser.Custom Layout page to use.
--useDefaultLayout ou -udl--useDefaultLayout or -udl Utiliser la disposition par défaut pour les vues.Use the default layout for the views.
--force ou -f--force or -f Remplacer les fichiers existants.Overwrite existing files.
--relativeFolderPath ou -outDir--relativeFolderPath or -outDir Chemin relatif du dossier de sortie du projet où les fichiers sont générés.The relative output folder path from project where the file are generated. S’il n’est pas spécifié, les fichiers sont générés dans le dossier du projet.If not specified, files are generated in the project folder.

Le tableau ci-dessous répertorie les options uniques à aspnet-codegenerator razorpage :The following table lists options unique to aspnet-codegenerator razorpage:

OptionOption DescriptionDescription
--namespaceName ou -namespace--namespaceName or -namespace Nom de l’espace de noms à utiliser pour le PageModel généréThe name of the namespace to use for the generated PageModel
--partialView ou -partial--partialView or -partial Générer une vue partielle.Generate a partial view. Les options de mise en page -l et -udl sont ignorées si ceci est spécifié.Layout options -l and -udl are ignored if this is specified.
--noPageModel ou -npm--noPageModel or -npm Choisir de ne pas générer une classe PageModel pour le modèle videSwitch to not generate a PageModel class for Empty template

Utilisez le commutateur -h pour obtenir de l’aide sur la commande aspnet-codegenerator razorpage :Use the -h switch for help on the aspnet-codegenerator razorpage command:

dotnet aspnet-codegenerator razorpage -h

Consultez Générer automatiquement le modèle de film pour obtenir un exemple de dotnet aspnet-codegenerator razorpage.See Scaffold the movie model for an example of dotnet aspnet-codegenerator razorpage.

IdentitéIdentity

Voir Modèle automatique d’identitéSee Scaffold Identity