Udostępnij za pośrednictwem


Microsoft.AspNetCore.Mvc.ApiExplorer Przestrzeń nazw

Udostępnia typy, które umożliwiają odnajdywanie metadanych, takich jak lista kontrolerów i akcji oraz ich adresy URL. Te typy są przydatne w przypadku interfejsów API documeting przy użyciu interfejsu OpenAPI.

Klasy

ApiConventionNameMatchAttribute

Określa zgodne zachowanie metody lub parametru konwencji interfejsu API według nazwy. ApiConventionNameMatchBehavior w przypadku opcji obsługiwanych. .

ApiConventionResult

Metadane skojarzone z metodą akcji za pośrednictwem konwencji interfejsu API.

ApiConventionTypeMatchAttribute

Określa zachowanie zgodnego parametru konwencji interfejsu API według typu. ApiConventionTypeMatchBehavior w przypadku opcji obsługiwanych. .

ApiDescription

Reprezentuje interfejs API uwidoczniony przez tę aplikację.

ApiDescriptionExtensions

Metody rozszerzenia dla programu ApiDescription.

ApiDescriptionGroup

Reprezentuje grupę powiązanych interfejsów API.

ApiDescriptionGroupCollection

Buforowana kolekcja .ApiDescriptionGroup

ApiDescriptionGroupCollectionProvider

Zapewnia dostęp do kolekcji .ApiDescriptionGroup

ApiDescriptionProviderContext

Obiekt kontekstu dla ApiDescription dostawców.

ApiParameterDescription

Opis metadanych danych wejściowych interfejsu API.

ApiParameterRouteInfo

Opis metadanych informacji o routingu dla elementu ApiParameterDescription.

ApiRequestFormat

Możliwy format treści żądania.

ApiResponseFormat

Możliwy format dla elementu ApiResponseType.

ApiResponseType

Możliwy typ treści odpowiedzi sformatowanej przez ApiResponseFormatselement .

DefaultApiDescriptionProvider

Implementuje dostawcę akcji reprezentowanych ApiDescription przez program ControllerActionDescriptor.

Interfejsy

IApiDefaultResponseMetadataProvider

Udostępnia typ zwracany dla wszystkich kodów stanu HTTP, które nie są objęte innymi IApiResponseMetadataProvider wystąpieniami.

IApiDescriptionGroupCollectionProvider

Zapewnia dostęp do kolekcji .ApiDescriptionGroup

IApiDescriptionGroupNameProvider

Reprezentuje metadane nazwy grupy dla elementu ApiDescription.

IApiDescriptionProvider

Definiuje kontrakt do określania ApiDescription wystąpień.

IApiDescriptionVisibilityProvider

Reprezentuje metadane widoczności dla elementu ApiDescription.

IApiRequestFormatMetadataProvider

Zawiera informacje o metadanych dotyczące formatu żądania do elementu IApiDescriptionProvider.

IApiRequestMetadataProvider

Udostępnia zestaw możliwych typów zawartości niż może być używany przez akcję.

IApiResponseMetadataProvider

Zapewnia typ zwracany, kod stanu i zestaw możliwych typów zawartości zwracanych przez pomyślne wykonanie akcji.

IApiResponseTypeMetadataProvider

Zawiera informacje o metadanych dotyczące formatu odpowiedzi na element IApiDescriptionProvider.

Wyliczenia

ApiConventionNameMatchBehavior

Zachowanie dopasowania nazwy parametru lub metody konwencji.

ApiConventionTypeMatchBehavior

Zachowanie dopasowania typu parametru konwencji.

Uwagi

Aby zapoznać się z wprowadzeniem do programu Swagger (OpenAPI), ASP.NET Core dokumentację internetowego interfejsu API za pomocą programu Swagger /OpenAPI.