IApiDescriptionProvider Antarmuka

Definisi

Ruang nama:

Microsoft.AspNetCore.Mvc.ApiExplorer

Rakitan:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Sumber:

IApiDescriptionProvider.cs

Menentukan kontrak untuk menentukan ApiDescription instans.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Turunan

Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Keterangan

Pada kueri pertama untuk ActionDescriptor, MVC memanggil semua instans IApiDescriptionProvider terdaftar dalam urutan urutan naik dari Order.

Setiap penyedia memiliki metode yang OnProvidersExecuting(ApiDescriptionProviderContext) disebut secara berurutan dan diberikan instans yang sama dari ApiDescriptionProviderContext. Kemudian setiap penyedia memiliki metode yang OnProvidersExecuted(ApiDescriptionProviderContext) disebut dalam urutan terbalik. Setiap instans memiliki kesempatan untuk menambahkan atau memodifikasi Results.

Karena penyedia dipanggil dalam urutan yang telah ditentukan sebelumnya, setiap penyedia memiliki kesempatan untuk mengamati dan menghias hasil penyedia yang telah berjalan.

Properti

Order

Mendapatkan nilai pesanan untuk menentukan urutan eksekusi penyedia. Penyedia dijalankan dalam nilai Order numerik properti yang naik.

Metode

OnProvidersExecuted(ApiDescriptionProviderContext)	Dipanggil setelah IApiDescriptionProvider implementasi dengan nilai yang lebih tinggi Order telah dipanggil.
OnProvidersExecuting(ApiDescriptionProviderContext)	Membuat atau memodifikasi ApiDescription.