DefaultApiDescriptionProvider Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:: Microsoft.AspNetCore.Mvc.ApiExplorer.dll

Package:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0

Package:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0

Package:: Microsoft.AspNetCore.Mvc.ApiExplorer v2.0.0

Package:: Microsoft.AspNetCore.Mvc.ApiExplorer v2.1.0

Package:: Microsoft.AspNetCore.Mvc.ApiExplorer v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0

Source:: DefaultApiDescriptionProvider.cs

Source:: DefaultApiDescriptionProvider.cs

Source:: DefaultApiDescriptionProvider.cs

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.

Implements a provider of ApiDescription for actions represented by ControllerActionDescriptor.

public ref class DefaultApiDescriptionProvider : Microsoft::AspNetCore::Mvc::ApiExplorer::IApiDescriptionProvider

public class DefaultApiDescriptionProvider : Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider

type DefaultApiDescriptionProvider = class
    interface IApiDescriptionProvider

Public Class DefaultApiDescriptionProvider
Implements IApiDescriptionProvider

Inheritance: Object
DefaultApiDescriptionProvider

Implements: IApiDescriptionProvider

Constructors

DefaultApiDescriptionProvider(IOptions<MvcOptions>, IInlineConstraintResolver, IModelMetadataProvider, IActionResultTypeMapper, IOptions<RouteOptions>)	Creates a new instance of DefaultApiDescriptionProvider.
DefaultApiDescriptionProvider(IOptions<MvcOptions>, IInlineConstraintResolver, IModelMetadataProvider, IActionResultTypeMapper)	Obsolete. Creates a new instance of DefaultApiDescriptionProvider.
DefaultApiDescriptionProvider(IOptions<MvcOptions>, IInlineConstraintResolver, IModelMetadataProvider)	Obsolete. Creates a new instance of DefaultApiDescriptionProvider.

Properties

Order

Gets the order value for determining the order of execution of providers. Providers execute in ascending numeric value of the Order property.

Methods

OnProvidersExecuted(ApiDescriptionProviderContext)	Called after IApiDescriptionProvider implementations with higher Order values have been called.
OnProvidersExecuting(ApiDescriptionProviderContext)	Creates or modifies ApiDescriptions.

Applies to

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

Share via