alat generator kode ASP.NET Core (aspnet-codegenerator)

Perintah dotnet aspnet-codegenerator menjalankan mesin perancah ASP.NET Core. dotnet aspnet-codegenerator Menjalankan perintah diperlukan untuk perancah dari baris perintah atau saat menggunakan Visual Studio Code. Perintah tidak diperlukan untuk menggunakan perancah dengan Visual Studio, yang mencakup mesin perancah secara default.

Menginstal dan memperbarui alat generator kode

Instal .NET SDK.

dotnet aspnet-codegenerator adalah alat global yang harus diinstal. Perintah berikut menginstal versi stabil terbaru dari alat generator kode ASP.NET Core:

dotnet tool install -g dotnet-aspnet-codegenerator

Note

Secara default arsitektur biner .NET yang akan diinstal mewakili arsitektur OS yang sedang berjalan. Untuk menentukan arsitektur OS yang berbeda, lihat penginstalan alat dotnet, opsi --arch. Untuk informasi selengkapnya, lihat Masalah GitHub dotnet/AspNetCore.Docs #29262.

Jika alat sudah diinstal, perintah berikut memperbarui alat ke versi stabil terbaru yang tersedia dari .NET SDK yang diinstal:

dotnet tool update -g dotnet-aspnet-codegenerator

Menghapus instalan alat generator kode

Mungkin perlu untuk menghapus instalan alat generator kode ASP.NET Core untuk mengatasi masalah. Misalnya, jika Anda menginstal versi pratinjau alat, hapus instalannya sebelum menginstal versi yang dirilis.

Perintah berikut menghapus instalan alat generator kode ASP.NET Core dan menginstal versi stabil terbaru:

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

Synopsis

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]

Description

dotnet aspnet-codegenerator Perintah global menjalankan generator kode ASP.NET Core dan mesin perancah.

Arguments

generator

Generator kode untuk dijalankan. Generator yang tersedia ditampilkan dalam tabel berikut.

Generator	Operation
area	Perancah area.
blazor	Perancah Blazor membuat, membaca, memperbarui, menghapus, dan mencantumkan halaman.
blazor-identity	Blazor Identity Menghasilkan file.
controller	Perancah pengontrol.
identity	Perancah Identity.
minimalapi	Menghasilkan file titik akhir (dengan titik akhir CRUD API) yang diberikan model dan konteks database opsional.
razorpage	Razor Perancah.
view	Perancah tampilan.

Opsi

-b|--build-base-path

Jalur dasar build.

-c|--configuration {Debug|Release}

Menentukan konfigurasi build. Nilai defaultnya adalah Debug.

-h|--help

Mencetak bantuan singkat untuk perintah.

-n|--nuget-package-dir

Menentukan direktori paket NuGet.

--no-build

Tidak membangun proyek sebelum berjalan. Meneruskan --no-build juga secara implisit --no-restore mengatur bendera.

-p|--project <PATH>

Menentukan jalur file proyek yang akan dijalankan (nama folder atau jalur lengkap). Jika tidak ditentukan, alat default ke direktori saat ini.

-tfm|--target-framework

Kerangka kerja target yang akan digunakan.

Opsi pengaturan generator

Bagian berikut merinci opsi yang tersedia untuk generator yang didukung:

• Area (area)
• Pengontrol (controller)
• BlazorAku akan menemuinya.blazor
• Blazor IdentityAku akan menemuinya.blazor-identity
• IdentityAku akan menemuinya.identity
• API Minimal (minimalapi)
• Razor halaman (razorpage)
• Tampilan (view)

Opsi Wilayah

Penggunaan: dotnet aspnet-codegenerator area {AREA NAME}

Tempat {AREA NAME} penampung adalah nama area yang akan dihasilkan.

Perintah sebelumnya menghasilkan folder berikut:

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

-h|--help Gunakan opsi untuk bantuan:

dotnet aspnet-codegenerator area -h

Opsi Blazor

Razor komponen dapat di-scaffold secara individual untuk Blazor aplikasi dengan menentukan nama templat yang akan digunakan. Templat yang didukung adalah:

• Empty
• Create
• Edit
• Delete
• Details
• List
• CRUD: CRUD adalah akronim untuk Buat, Baca, Perbarui, dan Hapus. CRUD Templat menghasilkan Createkomponen , Edit, Delete, Detailsdan Index (List) untuk aplikasi.

Opsi untuk blazor generator ditampilkan dalam tabel berikut.

Option	Description
-dbProvider|--databaseProvider	Penyedia database yang akan digunakan. Opsi termasuk sqlserver (default), sqlite, cosmos, atau postgres.
-dc|--dataContext	Kelas konteks database yang akan digunakan.
-m|--model	Kelas model yang akan digunakan.
-ns|--namespaceName	Tentukan nama namespace layanan yang akan digunakan untuk file Titik Akhir yang dihasilkan.
--relativeFolderPath|-outDir	Jalur folder output relatif. Jika tidak ditentukan, file dihasilkan dalam folder proyek.

Lihat contoh berikut:

• Edit Menggunakan templat untuk menghasilkan Edit komponen (Edit.razor) di Components/Pages/MoviePages folder aplikasi. MoviePages Jika folder tidak ada, alat akan membuat folder secara otomatis.
• Menggunakan penyedia database SQLite.
• BlazorWebAppMovies.Data.BlazorWebAppMoviesContext Menggunakan untuk konteks database.
• Movie Menggunakan model.

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

-h|--help Gunakan opsi untuk bantuan:

dotnet aspnet-codegenerator blazor -h

Untuk contoh yang menggunakan blazor generator, lihat Membuat Blazor aplikasi database film (Gambaran Umum).

Untuk informasi selengkapnya, lihat komponen ASP.NET Core Blazor 'QuickGrid'.

Opsi BlazorIdentity

Komponen perancah IdentityRazor ke dalam Blazor aplikasi dengan blazor-identity generator.

Opsi untuk blazor-identity templat diperlihatkan dalam tabel berikut ini.

Option	Description
-dbProvider|--databaseProvider	Penyedia database yang akan digunakan. Opsi termasuk sqlserver (default) dan sqlite.
-dc|--dataContext	Kelas konteks database yang akan digunakan.
-f|--force	Gunakan opsi ini untuk menimpa file yang ada.
-fi|--files	Daftar file yang dipisahkan titik koma untuk perancah. -lf|--listFiles Gunakan opsi untuk melihat opsi yang tersedia.
-lf|--listFiles	Mencantumkan file yang dapat di-scaffold dengan menggunakan -fi|--files opsi .
-rn|--rootNamespace	Namespace layanan akar yang digunakan untuk menghasilkan Identity kode.
-u|--userClass	Nama kelas pengguna yang akan dihasilkan.

-h|--help Gunakan opsi untuk bantuan:

dotnet aspnet-codegenerator blazor-identity -h

Opsi pengontrol

Opsi umum diperlihatkan dalam tabel berikut.

Option	Description
-b|--bootstrapVersion	Menentukan versi bootstrap dan membuat wwwroot folder untuk aset Bootstrap jika folder tidak ada.
-dbProvider|--databaseProvider	Penyedia database yang akan digunakan. Opsi termasuk sqlserver (default), sqlite, cosmos, postgres.
-dc|--dataContext	Kelas konteks database yang akan digunakan atau nama kelas yang akan dihasilkan.
-f|--force	Timpa file yang ada.
-l|--layout	Halaman tata letak kustom yang akan digunakan.
-m|--model	Kelas model yang akan digunakan.
-outDir|--relativeFolderPath	Jalur folder output relatif. Jika tidak ditentukan, file dihasilkan dalam folder proyek.
-scripts|--referenceScriptLibraries	Pustaka skrip referensi dalam tampilan yang dihasilkan. _ValidationScriptsPartial Menambahkan ke Edit halaman dan Create .
-sqlite|--useSqlite	Bendera untuk menentukan apakah konteks database harus menggunakan SQLite alih-alih SQL Server.
-udl|--useDefaultLayout	Gunakan tata letak default untuk tampilan.

Opsi unik untuk controller diperlihatkan dalam tabel berikut ini.

Option	Description
-actions|--readWriteActions	Hasilkan pengontrol dengan tindakan baca/tulis tanpa model.
-api|--restWithNoViews	Buat pengontrol dengan REST API gaya. noViews diasumsikan dan opsi terkait tampilan apa pun diabaikan.
-async|--useAsyncActions	Hasilkan tindakan pengontrol asinkron.
-name|--controllerName	Nama pengontrol.
-namespace|--controllerNamespace	Tentukan nama namespace layanan yang akan digunakan untuk pengontrol yang dihasilkan.
-nv|--noViews	Tidak menghasilkan tampilan.

-h|--help Gunakan opsi untuk bantuan:

dotnet aspnet-codegenerator controller -h

Untuk contoh yang menggunakan controller generator, lihat Bagian 4, tambahkan model ke aplikasi MVC Inti ASP.NET.

Opsi Identity

Untuk informasi selengkapnya, lihat Perancah Identity dalam proyek ASP.NET Core.

Opsi API minimal

Buat perancah backend API Minimal dengan minimalapi templat.

Opsi untuk minimalapi diperlihatkan dalam tabel berikut ini.

Option	Description
-dbProvider|--databaseProvider	Penyedia database yang akan digunakan. Opsi termasuk sqlserver (default), sqlite, cosmos, atau postgres.
-dc|--dataContext	Kelas konteks database yang akan digunakan.
-e|--endpoints	Kelas titik akhir yang akan digunakan (bukan nama file).
-m|--model	Kelas model yang akan digunakan.
-namespace|--endpointsNamespace	Tentukan nama namespace layanan yang akan digunakan untuk file titik akhir yang dihasilkan.
-o|--open	Gunakan opsi ini untuk mengaktifkan OpenAPI.
-outDir|--relativeFolderPath	Jalur folder output relatif. Jika tidak ditentukan, file dihasilkan dalam folder proyek.
-sqlite|--useSqlite	Bendera untuk menentukan apakah konteks database harus menggunakan SQLite alih-alih SQL Server.

Lihat contoh berikut:

• Menghasilkan kelas SpeakersEndpoints titik akhir bernama dengan titik akhir API yang memetakan ke operasi database menggunakan ApplicationDbContext kelas konteks database dan BackEnd.Models.Speaker model.
• app.MapSpeakerEndpoints(); Menambahkan ke Program file (Program.cs) untuk mendaftarkan kelas titik akhir.

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

-h|--help Gunakan opsi untuk bantuan:

dotnet aspnet-codegenerator minimalapi -h

Razor opsi halaman

Razor Halaman dapat di-scaffold secara individual dengan menentukan nama halaman baru dan templat yang akan digunakan. Templat yang didukung adalah:

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

Biasanya, templat dan nama file yang dihasilkan tidak ditentukan, yang membuat templat berikut:

• Create
• Edit
• Delete
• Details
• List

Opsi umum diperlihatkan dalam tabel berikut.

Option	Description
-b|--bootstrapVersion	Menentukan versi bootstrap dan membuat wwwroot folder untuk aset Bootstrap jika folder tidak ada.
-dbProvider|--databaseProvider	Penyedia database yang akan digunakan. Opsi termasuk sqlserver (default), sqlite, cosmos, postgres.
-dc|--dataContext	Kelas konteks database yang akan digunakan atau nama kelas yang akan dihasilkan.
-f|--force	Timpa file yang ada.
-l|--layout	Halaman tata letak kustom yang akan digunakan.
-m|--model	Kelas model yang akan digunakan.
-outDir|--relativeFolderPath	Jalur folder output relatif. Jika tidak ditentukan, file dihasilkan dalam folder proyek.
-scripts|--referenceScriptLibraries	Pustaka skrip referensi dalam tampilan yang dihasilkan. _ValidationScriptsPartial Menambahkan ke Edit halaman dan Create .
-sqlite|--useSqlite	Bendera untuk menentukan apakah konteks database harus menggunakan SQLite alih-alih SQL Server.
-udl|--useDefaultLayout	Gunakan tata letak default untuk tampilan.

Opsi unik untuk razorpage diperlihatkan dalam tabel berikut ini.

Option	Description
-namespace|--namespaceName	Nama namespace layanan yang akan digunakan untuk kelas yang dihasilkan PageModel .
-npm|--noPageModel	Jangan buat PageModel kelas untuk Empty templat.
-partial|--partialView	Hasilkan tampilan parsial. Opsi -l tata letak dan -udl diabaikan jika ini ditentukan.

Contoh berikut menggunakan Edit templat untuk menghasilkan CustomEditPage.cshtml dan CustomEditPage.cshtml.cs di Pages/Movies folder:

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

-h|--help Gunakan opsi untuk bantuan:

dotnet aspnet-codegenerator razorpage -h

Untuk contoh yang menggunakan razorpage generator, lihat Bagian 2, tambahkan model.

Opsi tampilan

Tampilan dapat di-scaffold secara individual dengan menentukan nama tampilan dan templat. Templat yang didukung adalah:

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

Opsi umum diperlihatkan dalam tabel berikut.

Option	Description
-b|--bootstrapVersion	Menentukan versi bootstrap dan membuat wwwroot folder untuk aset Bootstrap jika folder tidak ada.
-dbProvider|--databaseProvider	Penyedia database yang akan digunakan. Opsi termasuk sqlserver (default), sqlite, cosmos, postgres.
-dc|--dataContext	Kelas konteks database yang akan digunakan atau nama kelas yang akan dihasilkan.
-f|--force	Timpa file yang ada.
-l|--layout	Halaman tata letak kustom yang akan digunakan.
-m|--model	Kelas model yang akan digunakan.
-outDir|--relativeFolderPath	Jalur folder output relatif. Jika tidak ditentukan, file dihasilkan dalam folder proyek.
-scripts|--referenceScriptLibraries	Pustaka skrip referensi dalam tampilan yang dihasilkan. _ValidationScriptsPartial Menambahkan ke Edit halaman dan Create .
-sqlite|--useSqlite	Bendera untuk menentukan apakah konteks database harus menggunakan SQLite alih-alih SQL Server.
-udl|--useDefaultLayout	Gunakan tata letak default untuk tampilan.

Opsi unik untuk view diperlihatkan dalam tabel berikut ini.

Option	Description
-namespace|--controllerNamespace	Tentukan nama namespace layanan yang akan digunakan untuk pengontrol yang dihasilkan.
-partial|--partialView	Hasilkan tampilan parsial. Opsi tata letak lainnya (-l dan -udl) diabaikan jika ini ditentukan.

Contoh berikut menggunakan Edit templat untuk dihasilkan CustomEditView.cshtml di Views/Movies folder:

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

-h|--help Gunakan opsi untuk bantuan:

dotnet aspnet-codegenerator view -h