Compartilhar via


Microsoft.AspNetCore.Mvc.ApiExplorer Namespace

Fornece tipos que permitem a descoberta de metadados, como a lista de controladores e ações e suas URLs. Esses tipos são úteis para apIs de documeting usando OpenAPI.

Classes

ApiConventionNameMatchAttribute

Determina o comportamento correspondente de um método de convenção de API ou parâmetro por nome. ApiConventionNameMatchBehavior para opções com suporte. .

ApiConventionResult

Metadados associados a um método de ação por meio da convenção de API.

ApiConventionTypeMatchAttribute

Determina o comportamento correspondente de um parâmetro de convenção de API por tipo. ApiConventionTypeMatchBehavior para opções com suporte. .

ApiDescription

Representa uma API exposta por este aplicativo.

ApiDescriptionExtensions

Métodos de extensão para ApiDescription.

ApiDescriptionGroup

Representa um grupo de apis relacionadas.

ApiDescriptionGroupCollection

Uma coleção armazenada em cache de ApiDescriptionGroup.

ApiDescriptionGroupCollectionProvider

Fornece acesso a uma coleção de ApiDescriptionGroup.

ApiDescriptionProviderContext

Um objeto de contexto para ApiDescription provedores.

ApiParameterDescription

Uma descrição de metadados de uma entrada para uma API.

ApiParameterRouteInfo

Uma descrição de metadados de informações de roteamento para um ApiParameterDescription.

ApiRequestFormat

Um formato possível para o corpo de uma solicitação.

ApiResponseFormat

Formato possível para um ApiResponseType.

ApiResponseType

Tipo possível do corpo da resposta que é formatado por ApiResponseFormats.

DefaultApiDescriptionProvider

Implementa um provedor de ApiDescription para ações representadas por ControllerActionDescriptor.

Interfaces

IApiDefaultResponseMetadataProvider

Fornece um tipo de retorno para todos os códigos de status HTTP que não são cobertos por outras IApiResponseMetadataProvider instâncias.

IApiDescriptionGroupCollectionProvider

Fornece acesso a uma coleção de ApiDescriptionGroup.

IApiDescriptionGroupNameProvider

Representa metadados de nome de grupo para um ApiDescription.

IApiDescriptionProvider

Define um contrato para especificar ApiDescription instâncias.

IApiDescriptionVisibilityProvider

Representa metadados de visibilidade para um ApiDescription.

IApiRequestFormatMetadataProvider

Fornece informações de metadados sobre o formato de solicitação para um IApiDescriptionProvider.

IApiRequestMetadataProvider

Fornece um conjunto de tipos de conteúdo possíveis que podem ser consumidos pela ação.

IApiResponseMetadataProvider

Fornece um tipo de retorno, status código e um conjunto de possíveis tipos de conteúdo retornados por uma execução bem-sucedida da ação.

IApiResponseTypeMetadataProvider

Fornece informações de metadados sobre o formato de resposta para um IApiDescriptionProvider.

Enumerações

ApiConventionNameMatchBehavior

O comportamento para corresponder ao nome de um parâmetro ou método de convenção.

ApiConventionTypeMatchBehavior

O comportamento para corresponder ao tipo de um parâmetro de convenção.

Comentários

Para obter uma introdução ao Swagger (OpenAPI), ASP.NET Core documentação da API Web com Swagger/OpenAPI.