Microsoft.AspNetCore.Mvc.ApiExplorer Obor názvů

Poskytuje typy, které umožňují zjišťovat metadata, jako je například seznam řadičů a akcí a jejich adresy URL. Tyto typy jsou užitečné pro rozhraní API documeting využívající OpenAPI.

Třídy

ApiConventionNameMatchAttribute	Určuje odpovídající chování metody konvence rozhraní API nebo parametru podle názvu. ApiConventionNameMatchBehavior pro podporované možnosti. .
ApiConventionResult	Metadata přidružená k metodě akce prostřednictvím konvence rozhraní API
ApiConventionTypeMatchAttribute	Určuje odpovídající chování parametr konvence rozhraní API podle typu. ApiConventionTypeMatchBehavior podporovaných možností. .
ApiDescription	Představuje rozhraní API vystavené touto aplikací.
ApiDescriptionExtensions	Metody rozšíření pro ApiDescription.
ApiDescriptionGroup	Představuje skupinu souvisejících apisů.
ApiDescriptionGroupCollection	Kolekce uložených ApiDescriptionGroupv mezipaměti .
ApiDescriptionGroupCollectionProvider	Poskytuje přístup k kolekci ApiDescriptionGroup.
ApiDescriptionProviderContext	Kontextový objekt pro ApiDescription zprostředkovatele.
ApiParameterDescription	Popis metadat vstupu do rozhraní API.
ApiParameterRouteInfo	Metadata popis informací o směrování pro ApiParameterDescription.
ApiRequestFormat	Možný formát textu požadavku.
ApiResponseFormat	Možný formát pro ApiResponseType.
ApiResponseType	Možný typ textu odpovědi, který je formátován .ApiResponseFormats
DefaultApiDescriptionProvider	Implementuje poskytovatele ApiDescription akcí reprezentovaných .ControllerActionDescriptor

Rozhraní

IApiDefaultResponseMetadataProvider	Poskytuje návratový typ pro všechny stavové kódy HTTP, které nejsou pokryty jinými IApiResponseMetadataProvider instancemi.
IApiDescriptionGroupCollectionProvider	Poskytuje přístup k kolekci ApiDescriptionGroup.
IApiDescriptionGroupNameProvider	Představuje metadata názvu skupiny pro rozhraní ApiDescription.
IApiDescriptionProvider	Definuje kontrakt pro určení ApiDescription instancí.
IApiDescriptionVisibilityProvider	Představuje metadata viditelnosti pro apiDescription.
IApiRequestFormatMetadataProvider	Poskytuje metadata informace o formátu požadavku IApiDescriptionProvider.
IApiRequestMetadataProvider	Poskytuje sadu možných typů obsahu, než může akce využívat.
IApiResponseMetadataProvider	Poskytuje návratový typ, stavový kód a sadu možných typů obsahu vrácených úspěšným spuštěním akce.
IApiResponseTypeMetadataProvider	Poskytuje metadata informace o formátu odpovědi pro IApiDescriptionProvider.

Výčty

ApiConventionNameMatchBehavior	Chování pro porovnávání názvu parametru nebo metody konvence.
ApiConventionTypeMatchBehavior	Chování odpovídající typu parametru konvence.

Poznámky

Úvod do Swagger (OpenAPI) ASP.NET Core dokumentaci k webovému rozhraní API s použitím Swagger/openapi.