nástroj pro generátor kódu ASP.NET Core (aspnet-codegenerator)

Příkaz dotnet aspnet-codegenerator spustí modul generování uživatelského rozhraní ASP.NET Core. dotnet aspnet-codegenerator Spuštění příkazu se vyžaduje ke generování uživatelského rozhraní z příkazového řádku nebo při použití editoru Visual Studio Code. Příkaz není nutný k použití generování uživatelského rozhraní v sadě Visual Studio, který ve výchozím nastavení zahrnuje modul generování uživatelského rozhraní.

Instalace a aktualizace nástroje generátoru kódu

Nainstalujte sadu .NET SDK.

dotnet aspnet-codegenerator je globální nástroj, který se musí nainstalovat. Následující příkaz nainstaluje nejnovější stabilní verzi nástroje pro generátor kódu ASP.NET Core:

.NET CLI

dotnet tool install -g dotnet-aspnet-codegenerator

Poznámka

Ve výchozím nastavení architektura binárních souborů .NET, které se mají nainstalovat, představuje aktuálně spuštěnou architekturu operačního systému. Pokud chcete zadat jinou architekturu operačního systému, přečtěte si téma instalace nástroje dotnet, možnost --arch. Další informace najdete v tématu o problému GitHubu dotnet/AspNetCore.Docs #29262.

Pokud je nástroj již nainstalovaný, následující příkaz nástroj aktualizuje na nejnovější stabilní verzi dostupnou z nainstalovaných sad .NET Core SDK:

.NET CLI

dotnet tool update -g dotnet-aspnet-codegenerator

Odinstalace nástroje generátoru kódu

K vyřešení problémů může být nutné odinstalovat nástroj pro generátor kódu ASP.NET Core. Pokud jste například nainstalovali verzi Preview nástroje, odinstalujte ji před instalací vydané verze.

Následující příkazy odinstalují nástroj pro generátor kódu ASP.NET Core a nainstalují nejnovější stabilní verzi:

.NET CLI

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

Synopse

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

Popis

Globální dotnet aspnet-codegenerator příkaz spustí generátor kódu ASP.NET Core a modul generování uživatelského rozhraní.

Argumenty

generator

Generátor kódu, který se má spustit. Dostupné generátory jsou uvedeny v následující tabulce.

Generátor	Operace
area	Vygeneruje oblast.
blazor	Generování uživatelského rozhraní vytváří, čte, aktualizuje, odstraní a vypíše Blazor stránky.
blazor-identity	Blazor Identity Generuje soubory.
controller	Vygeneruje kontroler.
identity	Lešení Identity.
minimalapi	Vygeneruje soubor koncových bodů (s koncovými body rozhraní CRUD API) vzhledem k modelu a volitelnému kontextu databáze.
razorpage	Vygeneruje Razor stránky.
view	Vygeneruje zobrazení.

Možnosti

-b|--build-base-path

Základní cesta sestavení.

-c|--configuration {Debug|Release}

Definuje konfiguraci sestavení. Výchozí hodnota je Debug.

-h|--help

Vytiskne krátkou nápovědu pro příkaz.

-n|--nuget-package-dir

Určuje adresář balíčku NuGet.

--no-build

Nevystaví projekt před spuštěním. Předání --no-build také implicitně nastaví --no-restore příznak.

-p|--project <PATH>

Určuje cestu ke spuštění souboru projektu (název složky nebo úplná cesta). Pokud není zadaný, nástroj se ve výchozím nastavení nastaví na aktuální adresář.

-tfm|--target-framework

Cílová architektura , která se má použít.

Možnosti generátoru

Následující části obsahují podrobnosti o možnostech dostupných pro podporované generátory:

• Oblast (area)
• Kontroler (controller)
• Blazor (blazor)
• Blazor Identity (blazor-identity)
• Identity (identity)
• Minimální rozhraní API (minimalapi)
• Razor page (razorpage)
• Zobrazení (view)

Možnosti oblasti

Použití: dotnet aspnet-codegenerator area {AREA NAME}

Zástupný {AREA NAME} symbol je název oblasti, která se má vygenerovat.

Předchozí příkaz vygeneruje následující složky:

• Areas
  • {AREA NAME}
    • Controllers
    • Data
    • Models
    • Views

Použijte možnost nápovědy -h|--help :

.NET CLI

dotnet aspnet-codegenerator area -h

Blazor volby

Razor komponenty se dají pro aplikace generovat Blazor jednotlivě zadáním názvu šablony, kterou chcete použít. Mezi podporované šablony patří:

• Empty
• Create
• Edit
• Delete
• Details
• List
• CRUD: CRUD je zkratka pro vytvoření, čtení, aktualizaci a odstranění. Šablona CRUD vytvoří Createkomponenty , , EditDelete, Details, a Index (List) pro aplikaci.

Možnosti generátoru blazor jsou uvedeny v následující tabulce.

Možnost	Popis
-dbProvider|--databaseProvider	Poskytovatel databáze, který se má použít. Mezi možnosti patří sqlserver (výchozí), sqlite, cosmosnebo postgres.
-dc|--dataContext	Třída kontextu databáze, která se má použít.
-m|--model	Modelová třída, která se má použít.
-ns|--namespaceName	Zadejte název oboru názvů, který se má použít pro vygenerovaný soubor koncových bodů.
--relativeFolderPath|-outDir	Relativní cesta k výstupní složce Pokud není zadaný, soubory se vygenerují ve složce projektu.

Následující příklad:

• Edit Pomocí šablony vygeneruje komponentu Edit (Edit.razor) ve Components/Pages/MoviePages složce aplikace. MoviePages Pokud složka neexistuje, nástroj ji automaticky vytvoří.
• Používá zprostředkovatele databáze SQLite.
• Používá BlazorWebAppMovies.Data.BlazorWebAppMoviesContext se pro kontext databáze.
• Movie Používá model.

.NET CLI

dotnet aspnet-codegenerator blazor Edit -dbProvider sqlite -dc BlazorWebAppMovies.Data.BlazorWebAppMoviesContext -m Movie -outDir Components/Pages

Použijte možnost nápovědy -h|--help :

.NET CLI

dotnet aspnet-codegenerator blazor -h

Příklad, který používá generátor, najdete v blazor tématu Vytvoření Blazor aplikace filmové databáze (Přehled).

Další informace najdete v ASP.NET Core Blazor `QuickGrid` komponentě.

Blazor Identity volby

Identity Razor Generování součástí do Blazor aplikace pomocí generátoru blazor-identity

Možnosti šablony blazor-identity jsou uvedené v následující tabulce.

Možnost	Popis
-dbProvider|--databaseProvider	Poskytovatel databáze, který se má použít. Mezi možnosti patří sqlserver (výchozí) a sqlite.
-dc|--dataContext	Třída kontextu databáze, která se má použít.
-f|--force	Tuto možnost použijte k přepsání existujících souborů.
-fi|--files	Seznam souborů oddělených středníkem, které se mají vygenerovat. Pomocí této -lf|--listFiles možnosti zobrazíte dostupné možnosti.
-lf|--listFiles	Zobrazí seznam souborů, které se dají vygenerovat pomocí této -fi|--files možnosti.
-rn|--rootNamespace	Kořenový obor názvů, který se má použít ke generování Identity kódu.
-u|--userClass	Název třídy uživatele, která se má vygenerovat.

Použijte možnost nápovědy -h|--help :

.NET CLI

dotnet aspnet-codegenerator blazor-identity -h

Možnosti kontroleru

Obecné možnosti jsou uvedeny v následující tabulce.

Možnost	Popis
-b|--bootstrapVersion	Určuje verzi bootstrap a vytvoří wwwroot složku pro prostředky Bootstrap, pokud složka není k dispozici.
-dbProvider|--databaseProvider	Poskytovatel databáze, který se má použít. Mezi možnosti patří sqlserver (výchozí), sqlite, cosmos, postgres.
-dc|--dataContext	Třída kontextu databáze, která se má použít, nebo název třídy, která se má vygenerovat.
-f|--force	Přepište existující soubory.
-l|--layout	Stránka vlastního rozložení, která se má použít.
-m|--model	Modelová třída, která se má použít.
-outDir|--relativeFolderPath	Relativní cesta k výstupní složce Pokud není zadaný, soubory se vygenerují ve složce projektu.
-scripts|--referenceScriptLibraries	Referenční knihovny skriptů ve vygenerovaných zobrazeních Přidá _ValidationScriptsPartial do Edit a Create stránky.
-sqlite|--useSqlite	Příznak, který určuje, jestli má kontext databáze místo SQL Serveru používat SQLite.
-udl|--useDefaultLayout	Pro zobrazení použijte výchozí rozložení.

Možnosti, které controller jsou jedinečné, jsou uvedeny v následující tabulce.

Možnost	Popis
-actions|--readWriteActions	Vygenerujte kontroler s akcemi čtení a zápisu bez modelu.
-api|--restWithNoViews	Vygenerování kontroleru pomocí REST rozhraní API stylu noViews se předpokládá a všechny možnosti související se zobrazením se ignorují.
-async|--useAsyncActions	Generování asynchronních akcí kontroleru
-name|--controllerName	Název kontroleru.
-namespace|--controllerNamespace	Zadejte název oboru názvů, který se má použít pro vygenerovaný kontroler.
-nv|--noViews	Generování žádných zobrazení

Použijte možnost nápovědy -h|--help :

.NET CLI

dotnet aspnet-codegenerator controller -h

Příklad, který používá controller generátor, viz část 4, přidání modelu do aplikace ASP.NET Core MVC.

Identity volby

Další informace najdete v tématu Generování uživatelského rozhraní Identity v projektech ASP.NET Core.

Minimální možnosti rozhraní API

Vygenerování minimálního back-endu minimalapi rozhraní API pomocí šablony

Možnosti jsou minimalapi uvedené v následující tabulce.

Možnost	Popis
-dbProvider|--databaseProvider	Poskytovatel databáze, který se má použít. Mezi možnosti patří sqlserver (výchozí), sqlite, cosmosnebo postgres.
-dc|--dataContext	Třída kontextu databáze, která se má použít.
-e|--endpoints	Třída koncových bodů, která se má použít (nikoli název souboru).
-m|--model	Modelová třída, která se má použít.
-namespace|--endpointsNamespace	Zadejte název oboru názvů, který se má použít pro vygenerovaný soubor koncových bodů.
-o|--open	Tuto možnost použijte k povolení OpenAPI.
-outDir|--relativeFolderPath	Relativní cesta k výstupní složce Pokud není zadaný, soubory se vygenerují ve složce projektu.
-sqlite|--useSqlite	Příznak, který určuje, jestli má kontext databáze místo SQL Serveru používat SQLite.

Následující příklad:

• Vygeneruje třídu koncových bodů pojmenovanou SpeakersEndpoints pomocí koncových bodů rozhraní API, které se mapují na databázové operace pomocí ApplicationDbContext třídy kontextu databáze a BackEnd.Models.Speaker modelu.
• Přidá app.MapSpeakerEndpoints(); do Program souboru (Program.cs) pro registraci třídy koncových bodů.

.NET CLI

dotnet aspnet-codegenerator minimalapi -dc ApplicationDbContext -e SpeakerEndpoints -m BackEnd.Models.Speaker -o

Použijte možnost nápovědy -h|--help :

.NET CLI

dotnet aspnet-codegenerator minimalapi -h

Razor možnosti stránky

Razor Stránky lze jednotlivě vygenerovat zadáním názvu nové stránky a šablony, kterou chcete použít. Mezi podporované šablony patří:

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

Obvykle není zadán název šablony a vygenerovaného souboru, který vytvoří následující šablony:

• Create
• Edit
• Delete
• Details
• List

Obecné možnosti jsou uvedeny v následující tabulce.

Možnost	Popis
-b|--bootstrapVersion	Určuje verzi bootstrap a vytvoří wwwroot složku pro prostředky Bootstrap, pokud složka není k dispozici.
-dbProvider|--databaseProvider	Poskytovatel databáze, který se má použít. Mezi možnosti patří sqlserver (výchozí), sqlite, cosmos, postgres.
-dc|--dataContext	Třída kontextu databáze, která se má použít, nebo název třídy, která se má vygenerovat.
-f|--force	Přepište existující soubory.
-l|--layout	Stránka vlastního rozložení, která se má použít.
-m|--model	Modelová třída, která se má použít.
-outDir|--relativeFolderPath	Relativní cesta k výstupní složce Pokud není zadaný, soubory se vygenerují ve složce projektu.
-scripts|--referenceScriptLibraries	Referenční knihovny skriptů ve vygenerovaných zobrazeních Přidá _ValidationScriptsPartial do Edit a Create stránky.
-sqlite|--useSqlite	Příznak, který určuje, jestli má kontext databáze místo SQL Serveru používat SQLite.
-udl|--useDefaultLayout	Pro zobrazení použijte výchozí rozložení.

Možnosti, které razorpage jsou jedinečné, jsou uvedeny v následující tabulce.

Možnost	Popis
-namespace|--namespaceName	Název oboru názvů, který se má použít pro vygenerovanou PageModel třídu.
-npm|--noPageModel	Nevygenerujte PageModel pro Empty šablonu třídu.
-partial|--partialView	Vygenerujte částečné zobrazení. Možnosti -l rozložení a -udl jsou ignorovány, pokud je zadáno.

Následující příklad používá Edit šablonu k vygenerování CustomEditPage.cshtml a CustomEditPage.cshtml.cs ve Pages/Movies složce:

.NET CLI

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

Použijte možnost nápovědy -h|--help :

.NET CLI

dotnet aspnet-codegenerator razorpage -h

Příklad, který používá razorpage generátor, viz část 2, přidání modelu.

Možnosti zobrazení

Zobrazení lze jednotlivě vygenerovat zadáním názvu zobrazení a šablony. Mezi podporované šablony patří:

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

Obecné možnosti jsou uvedeny v následující tabulce.

Možnost	Popis
-b|--bootstrapVersion	Určuje verzi bootstrap a vytvoří wwwroot složku pro prostředky Bootstrap, pokud složka není k dispozici.
-dbProvider|--databaseProvider	Poskytovatel databáze, který se má použít. Mezi možnosti patří sqlserver (výchozí), sqlite, cosmos, postgres.
-dc|--dataContext	Třída kontextu databáze, která se má použít, nebo název třídy, která se má vygenerovat.
-f|--force	Přepište existující soubory.
-l|--layout	Stránka vlastního rozložení, která se má použít.
-m|--model	Modelová třída, která se má použít.
-outDir|--relativeFolderPath	Relativní cesta k výstupní složce Pokud není zadaný, soubory se vygenerují ve složce projektu.
-scripts|--referenceScriptLibraries	Referenční knihovny skriptů ve vygenerovaných zobrazeních Přidá _ValidationScriptsPartial do Edit a Create stránky.
-sqlite|--useSqlite	Příznak, který určuje, jestli má kontext databáze místo SQL Serveru používat SQLite.
-udl|--useDefaultLayout	Pro zobrazení použijte výchozí rozložení.

Možnosti, které view jsou jedinečné, jsou uvedeny v následující tabulce.

Možnost	Popis
-namespace|--controllerNamespace	Zadejte název oboru názvů, který se má použít pro vygenerovaný kontroler.
-partial|--partialView	Vygenerujte částečné zobrazení. Další možnosti rozložení (-l a -udl) se ignorují, pokud je zadáno.

Následující příklad používá Edit šablonu k vygenerování CustomEditView.cshtml ve Views/Movies složce:

.NET CLI

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

Použijte možnost nápovědy -h|--help :

.NET CLI

dotnet aspnet-codegenerator view -h