IApiDescriptionProvider Interfaz

Definición

Espacio de nombres:

Microsoft.AspNetCore.Mvc.ApiExplorer

Ensamblado:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Paquete:

Microsoft.AspNetCore.App.Ref v9.0.0

Define un contrato para especificar ApiDescription instancias.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Derivado

Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Comentarios

En la primera consulta de ActionDescriptor, MVC invoca todas las instancias registradas de IApiDescriptionProvider en el criterio de ordenación ascendente de Order.

Cada proveedor tiene su OnProvidersExecuting(ApiDescriptionProviderContext) método llamado en secuencia y dada la misma instancia de ApiDescriptionProviderContext. A continuación, cada proveedor tiene su OnProvidersExecuted(ApiDescriptionProviderContext) método al que se llama en el orden inverso. Cada instancia tiene la oportunidad de agregar o modificar Results.

A medida que se llama a los proveedores en una secuencia predefinida, cada proveedor tiene la oportunidad de observar y decorar el resultado de los proveedores que ya se han ejecutado.

Propiedades

Order

Obtiene el valor de orden para determinar el orden de ejecución de los proveedores. Los proveedores se ejecutan en un valor numérico ascendente de la Order propiedad .

Métodos

OnProvidersExecuted(ApiDescriptionProviderContext)	Se llama después IApiDescriptionProvider de llamar a las implementaciones con valores más altos Order .
OnProvidersExecuting(ApiDescriptionProviderContext)	Crea o modifica ApiDescriptions.