Поделиться через


Microsoft.AspNetCore.Mvc.ApiExplorer Пространство имен

Предоставляет типы, позволяющие обнаруживать метаданные, такие как список контроллеров и действий, а также их URL-адреса. Эти типы полезны для documeting API с помощью OpenAPI.

Классы

ApiConventionNameMatchAttribute

Определяет поведение сопоставления метода соглашения API или параметра по имени. ApiConventionNameMatchBehavior для поддерживаемых параметров. .

ApiConventionResult

Метаданные, связанные с методом действия с помощью соглашения API.

ApiConventionTypeMatchAttribute

Определяет поведение сопоставления параметра соглашения API по типу. ApiConventionTypeMatchBehavior для поддерживаемых параметров. .

ApiDescription

Представляет API, предоставляемый этим приложением.

ApiDescriptionExtensions

Методы расширения для ApiDescription.

ApiDescriptionGroup

Представляет группу связанных API.

ApiDescriptionGroupCollection

Кэшированная коллекция .ApiDescriptionGroup

ApiDescriptionGroupCollectionProvider

Предоставляет доступ к коллекции .ApiDescriptionGroup

ApiDescriptionProviderContext

Объект контекста для ApiDescription поставщиков.

ApiParameterDescription

Описание метаданных входных данных в API.

ApiParameterRouteInfo

Описание метаданных сведений о маршрутизации для ApiParameterDescription.

ApiRequestFormat

Возможный формат текста запроса.

ApiResponseFormat

Возможный ApiResponseTypeформат для .

ApiResponseType

Возможный тип текста ответа, отформатированный по ApiResponseFormats.

DefaultApiDescriptionProvider

Реализует поставщик для действий, представленных ApiDescription .ControllerActionDescriptor

Интерфейсы

IApiDefaultResponseMetadataProvider

Предоставляет тип возвращаемого значения для всех кодов состояния HTTP, которые не охватываются другими IApiResponseMetadataProvider экземплярами.

IApiDescriptionGroupCollectionProvider

Предоставляет доступ к коллекции .ApiDescriptionGroup

IApiDescriptionGroupNameProvider

Представляет метаданные имени группы для .ApiDescription

IApiDescriptionProvider

Определяет контракт для указания ApiDescription экземпляров.

IApiDescriptionVisibilityProvider

Представляет метаданные видимости для объекта ApiDescription.

IApiRequestFormatMetadataProvider

Предоставляет метаданные о формате запроса для IApiDescriptionProvider.

IApiRequestMetadataProvider

Предоставляет набор возможных типов контента, которые могут использоваться действием.

IApiResponseMetadataProvider

Предоставляет тип возвращаемого значения, код состояния и набор возможных типов контента, возвращаемых при успешном выполнении действия.

IApiResponseTypeMetadataProvider

Предоставляет метаданные о формате ответа для .IApiDescriptionProvider

Перечисления

ApiConventionNameMatchBehavior

Поведение для сопоставления имени параметра соглашения или метода.

ApiConventionTypeMatchBehavior

Поведение для сопоставления типа параметра соглашения.

Комментарии

Общие сведения о Swagger (OpenAPI) ASP.NET Core документации по веб-API с помощью Swagger/OpenAPI.