Microsoft.AspNetCore.Mvc.ApiExplorer Spazio dei nomi

Fornisce tipi che consentono l'individuazione dei metadati, ad esempio l'elenco di controller e azioni, e i relativi URL. Questi tipi sono utili per l'uso delle API di documeting usando OpenAPI.

Classi

ApiConventionNameMatchAttribute

Determina il comportamento corrispondente di un metodo o di un parametro della convenzione API in base al nome. ApiConventionNameMatchBehavior per le opzioni supportate. .

ApiConventionResult

Metadati associati a un metodo di azione tramite convenzione API.

ApiConventionTypeMatchAttribute

Determina il comportamento corrispondente di un parametro della convenzione API in base al tipo. ApiConventionTypeMatchBehavior per le opzioni supportate. .

ApiDescription

Rappresenta un'API esposta da questa applicazione.

ApiDescriptionExtensions

Metodi di estensione per ApiDescription.

ApiDescriptionGroup

Rappresenta un gruppo di API correlate.

ApiDescriptionGroupCollection

Raccolta memorizzata nella cache di ApiDescriptionGroup.

ApiDescriptionGroupCollectionProvider

Fornisce l'accesso a una raccolta di ApiDescriptionGroup.

ApiDescriptionProviderContext

Oggetto di contesto per ApiDescription i provider.

ApiParameterDescription

Descrizione dei metadati di un input in un'API.

ApiParameterRouteInfo

Descrizione dei metadati delle informazioni di routing per un ApiParameterDescriptionoggetto .

ApiRequestFormat

Formato possibile per il corpo di una richiesta.

ApiResponseFormat

Possibile formato per un ApiResponseTypeoggetto .

ApiResponseType

Tipo possibile del corpo della risposta formattato da ApiResponseFormats.

DefaultApiDescriptionProvider

Implementa un provider di ApiDescription per le azioni rappresentate da ControllerActionDescriptor.

Interfacce

IApiDefaultResponseMetadataProvider

Fornisce un tipo restituito per tutti i codici di stato HTTP non coperti da altre IApiResponseMetadataProvider istanze.

IApiDescriptionGroupCollectionProvider

Fornisce l'accesso a una raccolta di ApiDescriptionGroup.

IApiDescriptionGroupNameProvider

Rappresenta i metadati dei nomi di gruppo per un ApiDescriptionoggetto .

IApiDescriptionProvider

Definisce un contratto per specificare ApiDescription le istanze.

IApiDescriptionVisibilityProvider

Rappresenta i metadati di visibilità per un ApiDescriptionoggetto .

IApiRequestFormatMetadataProvider

Fornisce informazioni sui metadati sul formato della richiesta in un IApiDescriptionProvideroggetto .

IApiRequestMetadataProvider

Fornisce un set di tipi di contenuto possibili che possono essere usati dall'azione.

IApiResponseMetadataProvider

Fornisce un tipo restituito, codice di stato e un set di possibili tipi di contenuto restituiti da un'esecuzione riuscita dell'azione.

IApiResponseTypeMetadataProvider

Fornisce informazioni sui metadati sul formato di risposta in un IApiDescriptionProvideroggetto .

Enumerazioni

ApiConventionNameMatchBehavior

Comportamento per la corrispondenza del nome di un parametro o di un metodo di convenzione.

ApiConventionTypeMatchBehavior

Comportamento per la corrispondenza del tipo di parametro di convenzione.

Commenti

Per un'introduzione a Swagger (OpenAPI), ASP.NET Core documentazione dell'API Web con Swagger/OpenAPI.