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

Poskytuje typy, které umožňují zjišťování metadat, jako je seznam kontrolerů a akcí a jejich adresy URL. Tyto typy jsou užitečné pro documetování rozhraní API pomocí 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í parametru konvence rozhraní API podle typu. ApiConventionTypeMatchBehavior pro podporované možnosti. .
ApiDescription	Představuje rozhraní API vystavené touto aplikací.
ApiDescriptionExtensions	Rozšiřující metody pro ApiDescription.
ApiDescriptionGroup	Představuje skupinu souvisejících rozhraní API.
ApiDescriptionGroupCollection	Kolekce uložených v mezipaměti souboru ApiDescriptionGroup.
ApiDescriptionGroupCollectionProvider	Poskytuje přístup ke kolekci .ApiDescriptionGroup
ApiDescriptionProviderContext	Objekt kontextu pro ApiDescription zprostředkovatele.
ApiParameterDescription	Popis metadat vstupu do rozhraní API.
ApiParameterRouteInfo	Popis metadat 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 pomocí ApiResponseFormats.
DefaultApiDescriptionProvider	Implementuje poskytovatele ApiDescription pro akce reprezentované .ControllerActionDescriptor

Rozhraní

IApiDefaultResponseMetadataProvider	Poskytuje návratový typ pro všechny stavové kódy HTTP, které nejsou pokryté jinými IApiResponseMetadataProvider instancemi.
IApiDescriptionGroupCollectionProvider	Poskytuje přístup ke kolekci .ApiDescriptionGroup
IApiDescriptionGroupNameProvider	Představuje metadata názvu skupiny pro ApiDescription.
IApiDescriptionProvider	Definuje kontrakt pro zadávání ApiDescription instancí.
IApiDescriptionVisibilityProvider	Představuje metadata viditelnosti pro ApiDescriptionobjekt .
IApiRequestFormatMetadataProvider	Poskytuje metadata informace o formátu požadavku na 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 provedením akce.
IApiResponseTypeMetadataProvider	Poskytuje metadata informace o formátu odpovědi na IApiDescriptionProvider.

Výčty

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

Poznámky

Úvod do Swaggeru (OpenAPI) ASP.NET Core dokumentaci k webovému rozhraní API s využitím Swaggeru nebo OpenAPI.