IApiDescriptionProvider Interface

Definição

Namespace:

Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Pacote:

Microsoft.AspNetCore.App.Ref v8.0.0

Origem:

IApiDescriptionProvider.cs

Define um contrato para especificar ApiDescription instâncias.

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

Comentários

Na primeira consulta para ActionDescriptor, o MVC invoca todas as instâncias registradas do IApiDescriptionProvider na ordem de classificação crescente de Order.

Cada provedor tem seu OnProvidersExecuting(ApiDescriptionProviderContext) método chamado em sequência e recebe a mesma instância de ApiDescriptionProviderContext. Em seguida, cada provedor tem seu OnProvidersExecuted(ApiDescriptionProviderContext) método chamado na ordem inversa. Cada instância tem a oportunidade de adicionar ou modificar Results.

Como os provedores são chamados em uma sequência predefinida, cada provedor tem a chance de observar e decorar o resultado dos provedores que já foram executados.

Propriedades

Order

Obtém o valor da ordem para determinar a ordem de execução de provedores. Os provedores são executados no valor numérico crescente da Order propriedade .

Métodos

OnProvidersExecuted(ApiDescriptionProviderContext)	Chamado depois que IApiDescriptionProvider implementações com valores mais altos Order foram chamadas.
OnProvidersExecuting(ApiDescriptionProviderContext)	Cria ou modifica ApiDescriptions.