ASP.NET Core kod oluşturucu aracı (`aspnet-codegenerator`)

Makale
11/06/2024

Not

Bu, bu makalenin en son sürümü değildir. Geçerli sürüm için bu makalenin .NET 9 sürümüne bakın.

Uyarı

ASP.NET Core'un bu sürümü artık desteklenmiyor. Daha fazla bilgi için bkz . .NET ve .NET Core Destek İlkesi. Geçerli sürüm için bu makalenin .NET 9 sürümüne bakın.

Önemli

Bu bilgiler, ticari olarak piyasaya sürülmeden önce önemli ölçüde değiştirilebilen bir yayın öncesi ürünle ilgilidir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.

Geçerli sürüm için bu makalenin .NET 9 sürümüne bakın.

komut, dotnet aspnet-codegenerator ASP.NET Core iskele altyapısını çalıştırır. dotnet aspnet-codegenerator Komutu çalıştırmak, komut satırından veya Visual Studio Code kullanırken yapı iskelesi yapmak için gereklidir. Komutun, varsayılan olarak yapı iskelesi altyapısını içeren Visual Studio ile iskele kullanmak için gerekli değildir.

Kod oluşturucu aracını yükleme ve güncelleştirme

.NET SDK'sını yükleyin.

dotnet aspnet-codegenerator yüklenmesi gereken genel bir araçtır . Aşağıdaki komut, ASP.NET Core kod oluşturucu aracının en son kararlı sürümünü yükler:

dotnet tool install -g dotnet-aspnet-codegenerator

Not

Varsayılan olarak yüklenecek .NET ikili dosyalarının mimarisi şu anda çalışan işletim sistemi mimarisini temsil eder. Farklı bir işletim sistemi mimarisi belirtmek için bkz . dotnet tool install, --arch option. Daha fazla bilgi için bkz. GitHub sorunu dotnet/AspNetCore.Docs #29262.

Araç zaten yüklüyse, aşağıdaki komut aracı yüklü .NET Core SDK'larından kullanılabilen en son kararlı sürüme güncelleştirir:

dotnet tool update -g dotnet-aspnet-codegenerator

Kod oluşturucu aracını kaldırma

Sorunları çözmek için ASP.NET Core kod oluşturucu aracının kaldırılması gerekebilir. Örneğin, aracın önizleme sürümünü yüklediyseniz, yayımlanan sürümü yüklemeden önce kaldırın.

Aşağıdaki komutlar ASP.NET Core kod oluşturucu aracını kaldırır ve en son kararlı sürümü yükler:

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

Özet

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]

Açıklama

Genel dotnet aspnet-codegenerator komut, ASP.NET Core kod oluşturucusunu ve iskele altyapısını çalıştırır.

Bağımsız değişkenler

generator

Çalıştırılacak kod oluşturucu. Kullanılabilir oluşturucular aşağıdaki tabloda gösterilmiştir.

Oluşturucu	İşlem
`area`	Bir alanı iskeleler.
`blazor`	yapı iskeleleri Blazor sayfaları oluşturur, okur, güncelleştirir, siler ve listeler.
`blazor-identity`	Dosyaları oluşturur BlazorIdentity .
`controller`	Bir denetleyiciyi iskeleler.
`identity`	yapı iskeleleri Identity.
`minimalapi`	Model ve isteğe bağlı veritabanı bağlamı verilen bir uç nokta dosyası (CRUD API uç noktalarıyla) oluşturur.
`razorpage`	yapı iskeleleri Razor sayfaları.
`view`	Bir görünümün iskelelerini oluşturur.

Oluşturucu	İşlem
`area`	Bir alanı iskeleler.
`controller`	Bir denetleyiciyi iskeleler.
`identity`	yapı iskeleleri Identity.
`minimalapi`	Model ve isteğe bağlı veritabanı bağlamı verilen bir uç nokta dosyası (CRUD API uç noktalarıyla) oluşturur.
`razorpage`	yapı iskeleleri Razor sayfaları.
`view`	Bir görünümün iskelelerini oluşturur.

Seçenekler

-b|--build-base-path

Derleme temel yolu.

-c|--configuration {Debug|Release}

Derleme yapılandırmasını tanımlar. Varsayılan değer şudur: Debug.

-h|--help

Komutu için kısa bir yardım yazdırır.

-n|--nuget-package-dir

NuGet paket dizinini belirtir.

--no-build

Çalıştırmadan önce projeyi derlemez. Geçirme de --no-build bayrağını örtük olarak ayarlar --no-restore .

-p|--project <PATH>

Çalıştırılacak proje dosyasının yolunu belirtir (klasör adı veya tam yol). Belirtilmezse, araç varsayılan olarak geçerli dizine geçer.

-tfm|--target-framework

Kullanılacak hedef çerçeve .

Oluşturucu seçenekleri

Aşağıdaki bölümlerde desteklenen oluşturucular için sağlanan seçenekler ayrıntılı olarak açıklanmıştır:

Alan (area)
Denetleyici (controller)
Blazor (blazor)
BlazorIdentity (blazor-identity)
Identity (identity)
Minimum API (minimalapi)
Razor sayfa (razorpage)
Görünüm (view)

Alan (area)
Denetleyici (controller)
Identity (identity)
Minimum API (minimalapi)
Razor sayfa (razorpage)
Görünüm (view)

Alan seçenekleri

Kullanım: dotnet aspnet-codegenerator area {AREA NAME}

Yer {AREA NAME} tutucu, oluşturulacak alanın adıdır.

Yukarıdaki komut aşağıdaki klasörleri oluşturur:

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

-h|--help Yardım için seçeneğini kullanın:

dotnet aspnet-codegenerator area -h

Blazor Seçenekler

Razor bileşenleri, kullanılacak şablonun adı belirtilerek uygulamalar için Blazor ayrı ayrı iskele oluşturulabilir. Desteklenen şablonlar şunlardır:

Empty
Create
Edit
Delete
Details
List
CRUD: CRUD , Oluşturma, Okuma, Güncelleştirme ve Silme kısaltmasıdır. Şablon, CRUD uygulama için , DeleteEdit, , Detailsve Index (List) bileşenleri oluştururCreate.

Oluşturucu seçenekleri blazor aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-dbProvider\|--databaseProvider`	Kullanılacak veritabanı sağlayıcısı. Seçenekler arasında `sqlserver` (varsayılan), `sqlite`, `cosmos`veya bulunur `postgres`.
`-dc\|--dataContext`	Kullanılacak veritabanı bağlam sınıfı.
`-m\|--model`	Kullanılacak model sınıfı.
`-ns\|--namespaceName`	Oluşturulan Endpoints dosyası için kullanılacak ad alanının adını belirtin.
`--relativeFolderPath\|-outDir`	Göreli çıkış klasörü yolu. Belirtilmezse, dosyalar proje klasöründe oluşturulur.

Aşağıdaki örnek:

Edit Uygulamanın klasöründe bir Edit bileşen (Edit.razor) Components/Pages/MoviePages oluşturmak için şablonu kullanır. MoviePages Klasör yoksa, araç klasörü otomatik olarak oluşturur.
SQLite veritabanı sağlayıcısını kullanır.
Veritabanı bağlamı için kullanır BlazorWebAppMovies.Data.BlazorWebAppMoviesContext .
Movie Modeli kullanır.

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

-h|--help Yardım için seçeneğini kullanın:

dotnet aspnet-codegenerator blazor -h

Oluşturucuyu blazor kullanan bir örnek için bkz . Film veritabanı uygulaması derleme Blazor (Genel Bakış).

Daha fazla bilgi için bkz . ASP.NET Core Blazor QuickGrid bileşeni.

BlazorIdentity Seçenekler

IdentityRazor Bileşenleri oluşturucuyla bir Blazor uygulamaya iskeleleyinblazor-identity.

Şablon seçenekleri blazor-identity aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-dbProvider\|--databaseProvider`	Kullanılacak veritabanı sağlayıcısı. Seçenekler arasında (varsayılan) ve `sqlite`bulunur `sqlserver` .
`-dc\|--dataContext`	Kullanılacak veritabanı bağlam sınıfı.
`-f\|--force`	Var olan dosyaların üzerine yazmak için bu seçeneği kullanın.
`-fi\|--files`	yapı iskelesi için noktalı virgülle ayrılmış dosyaların listesi. `-lf\|--listFiles` Kullanılabilir seçenekleri görmek için seçeneğini kullanın.
`-lf\|--listFiles`	seçeneği kullanılarak `-fi\|--files` yapı iskelesi oluşturulabilecek dosyaları listeler.
`-rn\|--rootNamespace`	Kod oluşturmak Identity için kullanılacak kök ad alanı.
`-u\|--userClass`	Oluşturulacak kullanıcı sınıfının adı.

-h|--help Yardım için seçeneğini kullanın:

dotnet aspnet-codegenerator blazor-identity -h

Denetleyici seçenekleri

Genel seçenekler aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-b\|--bootstrapVersion`	Bootstrap sürümünü belirtir ve klasör yoksa Bootstrap varlıkları için bir `wwwroot` klasör oluşturur.
`-dbProvider\|--databaseProvider`	Kullanılacak veritabanı sağlayıcısı. Seçenekler arasında `sqlserver` (varsayılan), `sqlite`, `cosmos`, `postgres`.
`-dc\|--dataContext`	Kullanılacak veritabanı bağlam sınıfı veya oluşturulacak sınıfın adı.
`-f\|--force`	Varolan dosyaların üzerine yaz.
`-l\|--layout`	Kullanılacak özel düzen sayfası.
`-m\|--model`	Kullanılacak model sınıfı.
`-outDir\|--relativeFolderPath`	Göreli çıkış klasörü yolu. Belirtilmezse, dosyalar proje klasöründe oluşturulur.
`-scripts\|--referenceScriptLibraries`	Oluşturulan görünümlerde başvuru betiği kitaplıkları. ve `Create` sayfalarına `Edit` ekler`_ValidationScriptsPartial`.
`-sqlite\|--useSqlite`	Veritabanı bağlamının SQL Server yerine SQLite kullanıp kullanmayacağını belirten bayrak.
`-udl\|--useDefaultLayout`	Görünümler için varsayılan düzeni kullanın.

için benzersiz controller seçenekler aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-actions\|--readWriteActions`	Model olmadan okuma/yazma eylemleriyle denetleyici oluşturma.
`-api\|--restWithNoViews`	Stil API'siyle REST bir denetleyici oluşturun. `noViews` varsayılır ve görünümle ilgili seçenekler yoksayılır.
`-async\|--useAsyncActions`	Zaman uyumsuz denetleyici eylemleri oluşturun.
`-name\|--controllerName`	Denetleyicinin adı.
`-namespace\|--controllerNamespace`	Oluşturulan denetleyici için kullanılacak ad alanının adını belirtin.
`-nv\|--noViews`	Görünüm oluşturma.

-h|--help Yardım için seçeneğini kullanın:

dotnet aspnet-codegenerator controller -h

Oluşturucuyu controller kullanan bir örnek için bkz . Bölüm 4, ASP.NET Core MVC uygulamasına model ekleme.

Identity Seçenekler

Daha fazla bilgi için bkz. ASP.NET Core projelerinde yapı iskelesiIdentity.

En düşük API seçenekleri

Şablonla Minimal API arka ucu iskelesi oluşturun minimalapi .

için seçenekleri minimalapi aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-dbProvider\|--databaseProvider`	Kullanılacak veritabanı sağlayıcısı. Seçenekler arasında `sqlserver` (varsayılan), `sqlite`, `cosmos`veya bulunur `postgres`.
`-dc\|--dataContext`	Kullanılacak veritabanı bağlam sınıfı.
`-e\|--endpoints`	Kullanılacak uç noktalar sınıfı (dosya adı değil).
`-m\|--model`	Kullanılacak model sınıfı.
`-namespace\|--endpointsNamespace`	Oluşturulan uç noktalar dosyası için kullanılacak ad alanının adını belirtin.
`-o\|--open`	OpenAPI'yi etkinleştirmek için bu seçeneği kullanın.
`-outDir\|--relativeFolderPath`	Göreli çıkış klasörü yolu. Belirtilmezse, dosyalar proje klasöründe oluşturulur.
`-sqlite\|--useSqlite`	Veritabanı bağlamının SQL Server yerine SQLite kullanıp kullanmayacağını belirten bayrak.

Aşağıdaki örnek:

Veritabanı bağlam sınıfını ve BackEnd.Models.Speaker modeli kullanarak ApplicationDbContext veritabanı işlemlerine eşleyen API uç noktalarıyla adlı SpeakersEndpoints bir uç nokta sınıfı oluşturur.
Uç noktalar sınıfını Program kaydetmek için dosyasına (Program.cs) eklerapp.MapSpeakerEndpoints();.

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

-h|--help Yardım için seçeneğini kullanın:

dotnet aspnet-codegenerator minimalapi -h

Razor sayfa seçenekleri

Razor Sayfalar, yeni sayfanın adı ve kullanılacak şablon belirtilerek tek tek yapı iskelesi oluşturulabilir. Desteklenen şablonlar şunlardır:

Empty
Create
Edit
Delete
Details
List

Genellikle şablon ve oluşturulan dosya adı belirtilmez ve bu da aşağıdaki şablonları oluşturur:

Create
Edit
Delete
Details
List

Genel seçenekler aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-b\|--bootstrapVersion`	Bootstrap sürümünü belirtir ve klasör yoksa Bootstrap varlıkları için bir `wwwroot` klasör oluşturur.
`-dbProvider\|--databaseProvider`	Kullanılacak veritabanı sağlayıcısı. Seçenekler arasında `sqlserver` (varsayılan), `sqlite`, `cosmos`, `postgres`.
`-dc\|--dataContext`	Kullanılacak veritabanı bağlam sınıfı veya oluşturulacak sınıfın adı.
`-f\|--force`	Varolan dosyaların üzerine yaz.
`-l\|--layout`	Kullanılacak özel düzen sayfası.
`-m\|--model`	Kullanılacak model sınıfı.
`-outDir\|--relativeFolderPath`	Göreli çıkış klasörü yolu. Belirtilmezse, dosyalar proje klasöründe oluşturulur.
`-scripts\|--referenceScriptLibraries`	Oluşturulan görünümlerde başvuru betiği kitaplıkları. ve `Create` sayfalarına `Edit` ekler`_ValidationScriptsPartial`.
`-sqlite\|--useSqlite`	Veritabanı bağlamının SQL Server yerine SQLite kullanıp kullanmayacağını belirten bayrak.
`-udl\|--useDefaultLayout`	Görünümler için varsayılan düzeni kullanın.

için benzersiz razorpage seçenekler aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-namespace\|--namespaceName`	Oluşturulan `PageModel` sınıf için kullanılacak ad alanının adı.
`-npm\|--noPageModel`	Şablon için sınıf `PageModel` oluşturmayın `Empty` .
`-partial\|--partialView`	Kısmi bir görünüm oluşturun. Düzen seçenekleri `-l` ve `-udl` bu belirtilirse yoksayılır.

Aşağıdaki örnek, ve klasörünü oluşturmak CustomEditPage.cshtml CustomEditPage.cshtml.cs Pages/Movies için şablonu kullanır:Edit

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

-h|--help Yardım için seçeneğini kullanın:

dotnet aspnet-codegenerator razorpage -h

Oluşturucuyu razorpage kullanan bir örnek için bkz . Bölüm 2, model ekleme.

Seçenekleri görüntüle

Görünümler, görünümün ve şablonun adı belirtilerek tek tek yapı iskelesi oluşturulabilir. Desteklenen şablonlar şunlardır:

Empty
Create
Edit
Delete
Details
List

Genel seçenekler aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-b\|--bootstrapVersion`	Bootstrap sürümünü belirtir ve klasör yoksa Bootstrap varlıkları için bir `wwwroot` klasör oluşturur.
`-dbProvider\|--databaseProvider`	Kullanılacak veritabanı sağlayıcısı. Seçenekler arasında `sqlserver` (varsayılan), `sqlite`, `cosmos`, `postgres`.
`-dc\|--dataContext`	Kullanılacak veritabanı bağlam sınıfı veya oluşturulacak sınıfın adı.
`-f\|--force`	Varolan dosyaların üzerine yaz.
`-l\|--layout`	Kullanılacak özel düzen sayfası.
`-m\|--model`	Kullanılacak model sınıfı.
`-outDir\|--relativeFolderPath`	Göreli çıkış klasörü yolu. Belirtilmezse, dosyalar proje klasöründe oluşturulur.
`-scripts\|--referenceScriptLibraries`	Oluşturulan görünümlerde başvuru betiği kitaplıkları. ve `Create` sayfalarına `Edit` ekler`_ValidationScriptsPartial`.
`-sqlite\|--useSqlite`	Veritabanı bağlamının SQL Server yerine SQLite kullanıp kullanmayacağını belirten bayrak.
`-udl\|--useDefaultLayout`	Görünümler için varsayılan düzeni kullanın.

için benzersiz view seçenekler aşağıdaki tabloda gösterilmiştir.

Seçenek	Açıklama
`-namespace\|--controllerNamespace`	Oluşturulan denetleyici için kullanılacak ad alanının adını belirtin.
`-partial\|--partialView`	Kısmi bir görünüm oluşturun. Bu belirtilirse diğer düzen seçenekleri (`-l` ve `-udl`) yoksayılır.

Aşağıdaki örnek, klasörde oluşturmak CustomEditView.cshtml Views/Movies için şablonu kullanırEdit:

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

-h|--help Yardım için seçeneğini kullanın:

dotnet aspnet-codegenerator view -h

Seçenek	Açıklama
`-dbProvider\|--databaseProvider`	Kullanılacak veritabanı sağlayıcısı. Seçenekler arasında (varsayılan) ve `sqlite`bulunur `sqlserver` .
`-dc\|--dataContext`	Kullanılacak veritabanı bağlam sınıfı.
`-f\|--force`	Var olan dosyaların üzerine yazmak için bu seçeneği kullanın.
`-fi\|--files`	yapı iskelesi için noktalı virgülle ayrılmış dosyaların listesi. `-lf\|--listFiles` Kullanılabilir seçenekleri görmek için seçeneğini kullanın.
`-lf\|--listFiles`	seçeneği kullanılarak `-fi\|--files` yapı iskelesi oluşturulabilecek dosyaları listeler.
`-rn\|--rootNamespace`	Kod oluşturmak Identity için kullanılacak kök ad alanı.
`-u\|--userClass`	Oluşturulacak kullanıcı sınıfının adı.

Aracılığıyla paylaş

ASP.NET Core kod oluşturucu aracı (`aspnet-codegenerator`)

Kod oluşturucu aracını yükleme ve güncelleştirme

Kod oluşturucu aracını kaldırma

Özet

Açıklama

Bağımsız değişkenler

Seçenekler

Oluşturucu seçenekleri

Alan seçenekleri

Blazor Seçenekler

BlazorIdentity Seçenekler

Denetleyici seçenekleri

Identity Seçenekler

En düşük API seçenekleri

Razor sayfa seçenekleri

Seçenekleri görüntüle

Ek kaynaklar

Aracılığıyla paylaş

ASP.NET Core kod oluşturucu aracı (aspnet-codegenerator)

Kod oluşturucu aracını yükleme ve güncelleştirme

Kod oluşturucu aracını kaldırma

Özet

Açıklama

Bağımsız değişkenler

Seçenekler

Oluşturucu seçenekleri

Alan seçenekleri

Blazor Seçenekler

BlazorIdentity Seçenekler

Denetleyici seçenekleri

Identity Seçenekler

En düşük API seçenekleri

Razor sayfa seçenekleri

Seçenekleri görüntüle

Ek kaynaklar

ASP.NET Core kod oluşturucu aracı (`aspnet-codegenerator`)