dotnet aspnet-codegeneratordotnet aspnet-codegenerator

作成者: Rick AndersonBy Rick Anderson

dotnet aspnet-codegenerator - ASP.NET Core のスキャフォールディング エンジンを実行します。dotnet aspnet-codegenerator - Runs the ASP.NET Core scaffolding engine. dotnet aspnet-codegenerator が必要になるのは、コマンド ラインからスキャフォールディングする場合のみです。Visual Studio でスキャフォールディングする場合は必要ありません。dotnet aspnet-codegenerator is only required to scaffold from the command line, it's not needed to use scaffolding with Visual Studio.

aspnet-codegenerator のインストールと更新Install and update aspnet-codegenerator

.NET SDK をインストールします。Install the .NET SDK.

dotnet-aspnet-codegeneratorグローバル ツールであり、インストールする必要があります。dotnet-aspnet-codegenerator is a global tool that must be installed. 次のコマンドを使うと、dotnet-aspnet-codegenerator ツールの最新の安定バージョンをインストールできます。The following command installs the latest stable version of the dotnet-aspnet-codegenerator tool:

dotnet tool install -g dotnet-aspnet-codegenerator

次のコマンドを使うと、インストール済みの .NET Core SDK から利用できる更新の安定バージョンに dotnet-aspnet-codegenerator を更新できます。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

aspnet-codegenerator のアンインストールUninstall aspnet-codegenerator

問題を解決するには、aspnet-codegenerator のアンインストールが必要になる場合があります。It may be necessary to uninstall the aspnet-codegenerator to resolve problems. たとえば、aspnet-codegenerator のプレビュー バージョンをインストールした場合は、リリース バージョンをインストールする前にアンインストールします。For example, if you installed a preview version of aspnet-codegenerator, uninstall it before installing the released version.

次のコマンドを使用すると、dotnet-aspnet-codegenerator ツールをアンインストールし、最新の安定バージョンをインストールできます。The following commands uninstall the dotnet-aspnet-codegenerator tool and installs the latest stable version:

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

dotnet aspnet-codegenerator グローバル コマンドを使うと、ASP.NET Core のコード ジェネレーターとスキャフォールディング エンジンが実行されます。The dotnet aspnet-codegenerator global command runs the ASP.NET Core code generator and scaffolding engine.

引数Arguments

generator

実行するコード ジェネレーター。The code generator to run. 次のジェネレーターを使用できます。The following generators are available:

GeneratorGenerator 操作Operation
areaarea 区分のスキャフォールディングScaffolds an Area
コントローラーcontroller コントローラーのスキャフォールディングScaffolds a controller
IDidentity Identity のスキャフォールディングScaffolds Identity
razorpagerazorpage Razor Pages のスキャフォールディングScaffolds Razor Pages
ビューview ビューのスキャフォールディングScaffolds a view

オプションOptions

-n|--nuget-package-dir

NuGet パッケージのディレクトリを指定します。Specifies the NuGet package directory.

-c|--configuration {Debug|Release}

ビルド構成を定義します。Defines the build configuration. 既定値は Debug です。The default value is Debug.

-tfm|--target-framework

使用するターゲット フレームワークです。Target Framework to use. たとえば、net46 のようにします。For example, net46.

-b|--build-base-path

ビルドのベース パスです。The build base path.

-h|--help

コマンドの短いヘルプを印刷します。Prints out a short help for the command.

--no-build

実行前にプロジェクトをビルドしません。Doesn't build the project before running. また、--no-restore フラグが暗黙的に設定されます。It also implicitly sets the --no-restore flag.

-p|--project <PATH>

実行するプロジェクト ファイルのパスを指定します (フォルダー名または完全なパス)。Specifies the path of the project file to run (folder name or full path). 指定しない場合は、既定で現在のディレクトリに設定されます。If not specified, it defaults to the current directory.

ジェネレーターのオプションGenerator options

以下のセクションでは、次のサポートされているジェネレーターで使用できるオプションについて詳しく説明します。The following sections detail the options available for the supported generators:

  • 区分Area
  • コントローラーController
  • Identity
  • RazorpageRazorpage
  • ViewView

Area のオプションArea options

このツールは、コントローラーとビューを含む ASP.NET Core Web プロジェクト用のものです。This tool is intended for ASP.NET Core web projects with controllers and views. Razor Pages アプリ用ではありません。It's not intended for Razor Pages apps.

使用方法: dotnet aspnet-codegenerator area AreaNameToGenerateUsage: dotnet aspnet-codegenerator area AreaNameToGenerate

上のコマンドを実行すると、次のフォルダーが生成されます。The preceding command generates the following folders:

  • 領域Areas
    • AreaNameToGenerateAreaNameToGenerate
      • コントローラーControllers
      • データData
      • ModelsModels
      • ビューViews

Controller のオプションController options

aspnet-codegenerator controller および razorpage 用のオプションの一覧を次の表に示します。The following table lists options for aspnet-codegenerator controller and razorpage:

オプションOption 説明Description
--model または -m--model or -m 使用するモデル クラス。Model class to use.
--dataContext または -dc--dataContext or -dc 使用する DbContext クラス。The DbContext class to use.
--bootstrapVersion または -b--bootstrapVersion or -b ブートストラップのバージョンを指定します。Specifies the bootstrap version. 有効な値は 3 または 4です。Valid values are 3 or 4. 既定値は 4 です。Default is 4. 指定されたバージョンのブートストラップ ファイルを含む wwwroot ディレクトリが必要で存在しない場合は、作成されます。If needed and not present, a wwwroot directory is created that includes the bootstrap files of the specified version.
--referenceScriptLibraries または -scripts--referenceScriptLibraries or -scripts 生成されたビューでスクリプト ライブラリを参照します。Reference script libraries in the generated views. [編集] および [作成] ページに _ValidationScriptsPartial を追加します。Adds _ValidationScriptsPartial to Edit and Create pages.
--layout または -l--layout or -l 使用するカスタム レイアウト ページ。Custom Layout page to use.
--useDefaultLayout または -udl--useDefaultLayout or -udl ビューの既定のレイアウトを使用します。Use the default layout for the views.
--force または -f--force or -f 既存のファイルを上書きします。Overwrite existing files.
--relativeFolderPath または -outDir--relativeFolderPath or -outDir ファイルが生成されるプロジェクトの相対出力フォルダー パス。The relative output folder path from project where the file are generated. 指定しない場合、ファイルはプロジェクト フォルダーに生成されます。If not specified, files are generated in the project folder.

aspnet-codegenerator controller に固有のオプションの一覧を次の表に示します。The following table lists options unique to aspnet-codegenerator controller:

オプションOption 説明Description
--controllerName または -name--controllerName or -name コントローラーの名前です。Name of the controller.
--useAsyncActions または -async--useAsyncActions or -async 非同期コントローラー アクションを生成します。Generate async controller actions.
--noViews または -nv--noViews or -nv ビューを生成 しませんGenerate no views.
--restWithNoViews または -api--restWithNoViews or -api REST スタイルの API でコントローラーを生成します。Generate a Controller with REST style API. noViews を前提とし、ビュー関連のオプションはすべて無視されます。noViews is assumed and any view related options are ignored.
--readWriteActions または -actions--readWriteActions or -actions モデルなしで読み取り/書き込みアクションを備えたコントローラーを生成します。Generate controller with read/write actions without a model.

aspnet-codegenerator controller コマンドに関するヘルプを取得するには、-h スイッチを使います。Use the -h switch for help on the aspnet-codegenerator controller command:

dotnet aspnet-codegenerator controller -h

dotnet aspnet-codegenerator controller の例については、映画モデルのスキャフォールディングに関する記事をご覧ください。See Scaffold the movie model for an example of dotnet aspnet-codegenerator controller.

RazorpageRazorpage

新しいページの名前と使用するテンプレートを指定すれば、Razor Pages を個別にスキャフォールディングできます。Razor Pages can be individually scaffolded by specifying the name of the new page and the template to use. サポートされているテンプレートは次のとおりです。The supported templates are:

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

たとえば、次のコマンドでは、編集テンプレートを使って MyEdit.cshtmlMyEdit.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

通常、テンプレートと生成されたファイル名は指定されず、次のテンプレートが作成されます。Typically, the template and generated file name is not specified, and the following templates are created:

  • Create
  • Edit
  • Delete
  • Details
  • List

aspnet-codegenerator razorpage および controller 用のオプションの一覧を次の表に示します。The following table lists options for aspnet-codegenerator razorpage and controller:

オプションOption 説明Description
--model または -m--model or -m 使用するモデル クラス。Model class to use.
--dataContext または -dc--dataContext or -dc 使用する DbContext クラス。The DbContext class to use.
--bootstrapVersion または -b--bootstrapVersion or -b ブートストラップのバージョンを指定します。Specifies the bootstrap version. 有効な値は 3 または 4です。Valid values are 3 or 4. 既定値は 4 です。Default is 4. 指定されたバージョンのブートストラップ ファイルを含む wwwroot ディレクトリが必要で存在しない場合は、作成されます。If needed and not present, a wwwroot directory is created that includes the bootstrap files of the specified version.
--referenceScriptLibraries または -scripts--referenceScriptLibraries or -scripts 生成されたビューでスクリプト ライブラリを参照します。Reference script libraries in the generated views. [編集] および [作成] ページに _ValidationScriptsPartial を追加します。Adds _ValidationScriptsPartial to Edit and Create pages.
--layout または -l--layout or -l 使用するカスタム レイアウト ページ。Custom Layout page to use.
--useDefaultLayout または -udl--useDefaultLayout or -udl ビューの既定のレイアウトを使用します。Use the default layout for the views.
--force または -f--force or -f 既存のファイルを上書きします。Overwrite existing files.
--relativeFolderPath または -outDir--relativeFolderPath or -outDir ファイルが生成されるプロジェクトの相対出力フォルダー パス。The relative output folder path from project where the file are generated. 指定しない場合、ファイルはプロジェクト フォルダーに生成されます。If not specified, files are generated in the project folder.

aspnet-codegenerator razorpage に固有のオプションの一覧を次の表に示します。The following table lists options unique to aspnet-codegenerator razorpage:

オプションOption 説明Description
--namespaceName または -namespace--namespaceName or -namespace 生成された PageModel に対して使用する名前空間の名前ですThe name of the namespace to use for the generated PageModel
--partialView または -partial--partialView or -partial 部分ビューを生成します。Generate a partial view. これを指定した場合、レイアウトのオプション -l と -udl は無視されます。Layout options -l and -udl are ignored if this is specified.
--noPageModel または -npm--noPageModel or -npm 空のテンプレートの PageModel クラスを生成しない動作に切り替えますSwitch to not generate a PageModel class for Empty template

aspnet-codegenerator razorpage コマンドに関するヘルプを取得するには、-h スイッチを使います。Use the -h switch for help on the aspnet-codegenerator razorpage command:

dotnet aspnet-codegenerator razorpage -h

dotnet aspnet-codegenerator razorpage の例については、映画モデルのスキャフォールディングに関する記事をご覧ください。See Scaffold the movie model for an example of dotnet aspnet-codegenerator razorpage.

Identity

Identity のスキャフォールディングに関する記事を参照してください。See Scaffold Identity