dotnet aspnet-codegenerator
作成者: Rick Anderson
dotnet aspnet-codegenerator - ASP.NET Core のスキャフォールディング エンジンを実行します。 dotnet aspnet-codegenerator が必要になるのは、コマンド ラインからスキャフォールディングする場合のみです。Visual Studio でスキャフォールディングする場合は必要ありません。
aspnet-codegenerator のインストールと更新
.NET SDK をインストールします。
dotnet aspnet-codegenerator はグローバル ツールであり、インストールする必要があります。 次のコマンドを使うと、dotnet aspnet-codegenerator ツールの最新の安定バージョンをインストールできます。
dotnet tool install -g dotnet-aspnet-codegenerator
注意
既定では、インストールする .NET バイナリのアーキテクチャは、現在実行中の OS アーキテクチャを表します。 別の OS アーキテクチャを指定するには、「dotnet tool install, --arch option」を参照してください。 詳細については、GitHub イシュー dotnet/AspNetCore.Docs #29262 を参照してください。
次のコマンドを使うと、インストール済みの .NET Core SDK から利用できる更新の安定バージョンに dotnet aspnet-codegenerator を更新できます。
dotnet tool update -g dotnet-aspnet-codegenerator
aspnet-codegenerator のアンインストール
問題を解決するには、aspnet-codegenerator のアンインストールが必要になる場合があります。 たとえば、aspnet-codegenerator のプレビュー バージョンをインストールした場合は、リリース バージョンをインストールする前にアンインストールします。
次のコマンドを使用すると、dotnet aspnet-codegenerator ツールをアンインストールし、最新の安定バージョンをインストールできます。
dotnet tool uninstall -g dotnet-aspnet-codegenerator
dotnet tool install -g dotnet-aspnet-codegenerator
構文
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]
説明
dotnet aspnet-codegenerator グローバル コマンドを使うと、ASP.NET Core のコード ジェネレーターとスキャフォールディング エンジンが実行されます。
引数
generator
実行するコード ジェネレーター。 次のジェネレーターを使用できます。
| Generator | 操作 |
|---|---|
| area | 区分のスキャフォールディング |
| コントローラー | コントローラーのスキャフォールディング |
| ID | Identity のスキャフォールディング |
| razorpage | Razor Pages のスキャフォールディング |
| ビュー | ビューのスキャフォールディング |
オプション
-n|--nuget-package-dir
NuGet パッケージのディレクトリを指定します。
-c|--configuration {Debug|Release}
ビルド構成を定義します。 既定値は Debug です。
-tfm|--target-framework
使用するターゲット フレームワークです。 たとえば、net46 のようにします。
-b|--build-base-path
ビルドのベース パスです。
-h|--help
コマンドの短いヘルプを印刷します。
--no-build
実行前にプロジェクトをビルドしません。 また、--no-restore フラグが暗黙的に設定されます。
-p|--project <PATH>
実行するプロジェクト ファイルのパスを指定します (フォルダー名または完全なパス)。 指定しない場合は、既定で現在のディレクトリに設定されます。
ジェネレーターのオプション
以下のセクションでは、次のサポートされているジェネレーターで使用できるオプションについて詳しく説明します。
- 区分
- コントローラー
- Identity
- Razorpage
- View
Area のオプション
このツールは、コントローラーとビューを含む ASP.NET Core Web プロジェクト用のものです。 Razor Pages アプリ用ではありません。
使用方法: dotnet aspnet-codegenerator area AreaNameToGenerate
上のコマンドを実行すると、次のフォルダーが生成されます。
- 領域
- AreaNameToGenerate
- コントローラー
- データ
- Models
- ビュー
- AreaNameToGenerate
Controller のオプション
次の表は、aspnet-codegeneratorrazorpage、controller、および view のオプションの一覧です。
| オプション | 説明 |
|---|---|
| --model または -m | 使用するモデル クラス。 |
| --dataContext または -dc | 使用する DbContext クラス、または生成するクラスの名前。 |
| --bootstrapVersion または -b | ブートストラップのバージョンを指定します。 有効な値は 3 または 4です。 既定値は 4 です。 指定されたバージョンのブートストラップ ファイルを含む wwwroot ディレクトリが必要で存在しない場合は、作成されます。 |
| --referenceScriptLibraries または -scripts | 生成されたビューでスクリプト ライブラリを参照します。 [編集] および [作成] ページに _ValidationScriptsPartial を追加します。 |
| --layout または -l | 使用するカスタム レイアウト ページ。 |
| --useDefaultLayout または -udl | ビューの既定のレイアウトを使用します。 |
| --force または -f | 既存のファイルを上書きします。 |
| --relativeFolderPath または -outDir | ファイルの生成先にする必要がある出力フォルダーのプロジェクトからの相対パスを指定します。指定しない場合、ファイルはプロジェクト フォルダー内に生成されます |
| --useSqlite または -sqlite | DbContext が SQL Server では SQLite を使用するかどうかを指定するフラグ。 |
aspnet-codegenerator controller に固有のオプションの一覧を次の表に示します。
| オプション | 説明 |
|---|---|
| --controllerName または -name | コントローラーの名前です。 |
| --useAsyncActions または -async | 非同期コントローラー アクションを生成します。 |
| --noViews または -nv | ビューを生成しません。 |
| --restWithNoViews または -api | REST スタイルの API でコントローラーを生成します。 noViews を前提とし、ビュー関連のオプションはすべて無視されます。 |
| --readWriteActions または -actions | モデルなしで読み取り/書き込みアクションを備えたコントローラーを生成します。 |
aspnet-codegenerator controller コマンドに関するヘルプを取得するには、-h スイッチを使います。
dotnet aspnet-codegenerator controller -h
dotnet aspnet-codegenerator controller の例については、映画モデルのスキャフォールディングに関する記事をご覧ください。
Razorpage
新しいページの名前と使用するテンプレートを指定すれば、Razor Pages を個別にスキャフォールディングできます。 サポートされているテンプレートは次のとおりです。
EmptyCreateEditDeleteDetailsList
たとえば、次のコマンドでは、編集テンプレートを使って MyEdit.cshtml と MyEdit.cshtml.cs が生成されます。
dotnet aspnet-codegenerator razorpage MyEdit Edit -m Movie -dc RazorPagesMovieContext -outDir Pages/Movies
通常、テンプレートと生成されたファイル名は指定されず、次のテンプレートが作成されます。
CreateEditDeleteDetailsList
次の表は、aspnet-codegeneratorrazorpage、controller、および view のオプションの一覧です。
| オプション | 説明 |
|---|---|
| --model または -m | 使用するモデル クラス。 |
| --dataContext または -dc | 使用する DbContext クラス、または生成するクラスの名前。 |
| --bootstrapVersion または -b | ブートストラップのバージョンを指定します。 有効な値は 3 または 4です。 既定値は 4 です。 指定されたバージョンのブートストラップ ファイルを含む wwwroot ディレクトリが必要で存在しない場合は、作成されます。 |
| --referenceScriptLibraries または -scripts | 生成されたビューでスクリプト ライブラリを参照します。 [編集] および [作成] ページに _ValidationScriptsPartial を追加します。 |
| --layout または -l | 使用するカスタム レイアウト ページ。 |
| --useDefaultLayout または -udl | ビューの既定のレイアウトを使用します。 |
| --force または -f | 既存のファイルを上書きします。 |
| --relativeFolderPath または -outDir | ファイルの生成先にする必要がある出力フォルダーのプロジェクトからの相対パスを指定します。指定しない場合、ファイルはプロジェクト フォルダー内に生成されます |
| --useSqlite または -sqlite | DbContext が SQL Server では SQLite を使用するかどうかを指定するフラグ。 |
aspnet-codegenerator razorpage に固有のオプションの一覧を次の表に示します。
| オプション | 説明 |
|---|---|
| --namespaceName または -namespace | 生成された PageModel に対して使用する名前空間の名前です |
| --partialView または -partial | 部分ビューを生成します。 これを指定した場合、レイアウトのオプション -l と -udl は無視されます。 |
| --noPageModel または -npm | 空のテンプレートの PageModel クラスを生成しない動作に切り替えます |
aspnet-codegenerator razorpage コマンドに関するヘルプを取得するには、-h スイッチを使います。
dotnet aspnet-codegenerator razorpage -h
dotnet aspnet-codegenerator razorpage の例については、映画モデルのスキャフォールディングに関する記事をご覧ください。
View
ビューの名前と使用するテンプレートを指定すれば、ビューを個別にスキャフォールディングできます。 サポートされているテンプレートは次のとおりです。
EmptyCreateEditDeleteDetailsList
たとえば、次のコマンドでは、編集テンプレートを使って MyEdit.cshtml が生成されます。
dotnet aspnet-codegenerator view MyEdit Edit -m Movie -dc MovieContext -outDir Views/Movies
次の表は、aspnet-codegeneratorrazorpage、controller、および view のオプションの一覧です。
| オプション | 説明 |
|---|---|
| --model または -m | 使用するモデル クラス。 |
| --dataContext または -dc | 使用する DbContext クラス、または生成するクラスの名前。 |
| --bootstrapVersion または -b | ブートストラップのバージョンを指定します。 有効な値は 3 または 4です。 既定値は 4 です。 指定されたバージョンのブートストラップ ファイルを含む wwwroot ディレクトリが必要で存在しない場合は、作成されます。 |
| --referenceScriptLibraries または -scripts | 生成されたビューでスクリプト ライブラリを参照します。 [編集] および [作成] ページに _ValidationScriptsPartial を追加します。 |
| --layout または -l | 使用するカスタム レイアウト ページ。 |
| --useDefaultLayout または -udl | ビューの既定のレイアウトを使用します。 |
| --force または -f | 既存のファイルを上書きします。 |
| --relativeFolderPath または -outDir | ファイルの生成先にする必要がある出力フォルダーのプロジェクトからの相対パスを指定します。指定しない場合、ファイルはプロジェクト フォルダー内に生成されます |
| --useSqlite または -sqlite | DbContext が SQL Server では SQLite を使用するかどうかを指定するフラグ。 |
aspnet-codegenerator view に固有のオプションの一覧を次の表に示します。
| オプション | 説明 |
|---|---|
| --controllerNamespace または -namespace | 生成されたコントローラーに対して使用する名前空間の名前を指定します |
| --partialView または -partial | 部分ビューを生成します。これを指定した場合、他のレイアウトのオプション (-l と -udl) は無視されます |
aspnet-codegenerator view コマンドに関するヘルプを取得するには、-h スイッチを使います。
dotnet aspnet-codegenerator view -h
Identity
Identity のスキャフォールディングに関する記事を参照してください。
ASP.NET Core
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示