IApiDescriptionProvider Arabirim

Başvuru

Tanım

Ad Alanı:: Microsoft.AspNetCore.Mvc.ApiExplorer

Bütünleştirilmiş Kod:: Microsoft.AspNetCore.Mvc.ApiExplorer.dll

Bütünleştirilmiş Kod:: Microsoft.AspNetCore.Mvc.Abstractions.dll

Paket:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0

Paket:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0

Paket:: Microsoft.AspNetCore.Mvc.Abstractions v2.0.0

Paket:: Microsoft.AspNetCore.Mvc.Abstractions v2.1.0

Paket:: Microsoft.AspNetCore.Mvc.Abstractions v2.2.0

Paket:: Microsoft.AspNetCore.App.Ref v3.0.1

Paket:: Microsoft.AspNetCore.App.Ref v3.1.10

Paket:: Microsoft.AspNetCore.App.Ref v5.0.0

Paket:: Microsoft.AspNetCore.App.Ref v6.0.6

Paket:: Microsoft.AspNetCore.App.Ref v7.0.5

Paket:: Microsoft.AspNetCore.App.Ref v8.0.0

Paket:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.1.24452.1

Kaynak:: IApiDescriptionProvider.cs

Önemli

Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.

Örnekleri belirtmek ApiDescription için bir sözleşme tanımlar.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Türetilmiş: Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Açıklamalar

için ActionDescriptorilk sorguda, MVC tüm kayıtlı örneklerini IApiDescriptionProvider artan sıralama düzeninde Orderçağırır.

Her sağlayıcının sıralı olarak adlandırılan ve aynı örneği verilen yöntemi vardır OnProvidersExecuting(ApiDescriptionProviderContext)ApiDescriptionProviderContext. Ardından her sağlayıcının ters sırada adlı bir yöntemi vardır OnProvidersExecuted(ApiDescriptionProviderContext) . Her örneğin ekleme veya değiştirme Resultsfırsatı vardır.

Sağlayıcılar önceden tanımlanmış bir sırayla çağrıldığında, her sağlayıcının zaten çalıştırılan sağlayıcıların sonucunu gözlemleme ve süsleme şansı vardır.

Özellikler

Order

Sağlayıcıların yürütülmesinin sırasını belirlemek için sipariş değerini alır. Sağlayıcılar, özelliğin artan sayısal değeriyle Order yürütülür.

Yöntemler

OnProvidersExecuted(ApiDescriptionProviderContext)	Daha yüksek Order değerlere sahip uygulamalar çağrıldıktan sonra IApiDescriptionProvider çağrılır.
OnProvidersExecuting(ApiDescriptionProviderContext)	s oluşturur veya değiştirir ApiDescription.

Şunlara uygulanır

Aracılığıyla paylaş