Condividi tramite


Microsoft.AspNetCore.Mvc.ApiExplorer Spazio dei nomi

Fornisce tipi che consentono l'individuazione di metadati, ad esempio l'elenco di controller e azioni, e i relativi URL. Questi tipi sono utili per le API di documeting tramite 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 per 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 per un'API.

ApiParameterRouteInfo

Descrizione dei metadati delle informazioni di routing per un oggetto ApiParameterDescription.

ApiRequestFormat

Formato possibile per il corpo di una richiesta.

ApiResponseFormat

Formato possibile per un oggetto ApiResponseType.

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 del nome del gruppo per un oggetto ApiDescription.

IApiDescriptionProvider

Definisce un contratto per specificare ApiDescription le istanze.

IApiDescriptionVisibilityProvider

Rappresenta i metadati di visibilità per un oggetto ApiDescription.

IApiRequestFormatMetadataProvider

Fornisce informazioni sui metadati sul formato della richiesta a un oggetto IApiDescriptionProvider.

IApiRequestMetadataProvider

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

IApiResponseMetadataProvider

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

IApiResponseTypeMetadataProvider

Fornisce informazioni sui metadati sul formato di risposta a un oggetto IApiDescriptionProvider.

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 un parametro di convenzione.

Commenti

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