IApiDescriptionProvider Interface
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Define um contrato para especificar ApiDescription instâncias.
public interface class IApiDescriptionProvider
public interface IApiDescriptionProvider
type IApiDescriptionProvider = interface
Public Interface IApiDescriptionProvider
- Derivado
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. |