Microsoft.AspNetCore.Mvc.ApiExplorer Namespace

Reference

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides types that allow discovering metadata such as the list of controllers and actions, and their URLs. These types are useful for documeting APIs using OpenAPI.

Classes

ApiConventionNameMatchAttribute	Determines the matching behavior an API convention method or parameter by name. ApiConventionNameMatchBehavior for supported options. .
ApiConventionResult	Metadata associated with an action method via API convention.
ApiConventionTypeMatchAttribute	Determines the matching behavior an API convention parameter by type. ApiConventionTypeMatchBehavior for supported options. .
ApiDescription	Represents an API exposed by this application.
ApiDescriptionExtensions	Extension methods for ApiDescription.
ApiDescriptionGroup	Represents a group of related apis.
ApiDescriptionGroupCollection	A cached collection of ApiDescriptionGroup.
ApiDescriptionGroupCollectionProvider	Provides access to a collection of ApiDescriptionGroup.
ApiDescriptionProviderContext	A context object for ApiDescription providers.
ApiParameterDescription	A metadata description of an input to an API.
ApiParameterRouteInfo	A metadata description of routing information for an ApiParameterDescription.
ApiRequestFormat	A possible format for the body of a request.
ApiResponseFormat	Possible format for an ApiResponseType.
ApiResponseType	Possible type of the response body which is formatted by ApiResponseFormats.
DefaultApiDescriptionProvider	Implements a provider of ApiDescription for actions represented by ControllerActionDescriptor.

Interfaces

IApiDefaultResponseMetadataProvider	Provides a return type for all HTTP status codes that are not covered by other IApiResponseMetadataProvider instances.
IApiDescriptionGroupCollectionProvider	Provides access to a collection of ApiDescriptionGroup.
IApiDescriptionGroupNameProvider	Represents group name metadata for an `ApiDescription`.
IApiDescriptionProvider	Defines a contract for specifying ApiDescription instances.
IApiDescriptionVisibilityProvider	Represents visibility metadata for an `ApiDescription`.
IApiRequestFormatMetadataProvider	Provides metadata information about the request format to an `IApiDescriptionProvider`.
IApiRequestMetadataProvider	Provides a set of possible content types than can be consumed by the action.
IApiResponseMetadataProvider	Provides a return type, status code and a set of possible content types returned by a successful execution of the action.
IApiResponseTypeMetadataProvider	Provides metadata information about the response format to an `IApiDescriptionProvider`.

Enums

ApiConventionNameMatchBehavior	The behavior for matching the name of a convention parameter or method.
ApiConventionTypeMatchBehavior	The behavior for matching the type of a convention parameter.

Remarks

For an introduction to Swagger (OpenAPI), ASP.NET Core web API documentation with Swagger / OpenAPI.