DefaultApiDescriptionProvider Class

Summary

Implements a provider of [Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription](Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.yml) for actions represented by [Microsoft.AspNet.Mvc.ControllerActionDescriptor]().

Syntax

public class DefaultApiDescriptionProvider : IApiDescriptionProvider

GitHub

View on GitHub

class Microsoft.AspNet.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Constructors

DefaultApiDescriptionProvider(IOptions<Microsoft.AspNet.Mvc.MvcOptions>, IInlineConstraintResolver, Microsoft.AspNet.Mvc.ModelBinding.IModelMetadataProvider)

Creates a new instance of [Microsoft.AspNet.Mvc.ApiExplorer.DefaultApiDescriptionProvider](Microsoft.AspNet.Mvc.ApiExplorer.DefaultApiDescriptionProvider.yml).

Arguments:
  • optionsAccessor (IOptions{Microsoft.AspNet.Mvc.MvcOptions}) – The accessor for [Microsoft.AspNet.Mvc.MvcOptions]().
  • constraintResolver (IInlineConstraintResolver) – The @!:IInlineConstraintResolver- used for resolving inline constraints.
  • modelMetadataProvider (Microsoft.AspNet.Mvc.ModelBinding.IModelMetadataProvider) – The [Microsoft.AspNet.Mvc.ModelBinding.IModelMetadataProvider]().
public DefaultApiDescriptionProvider(IOptions<MvcOptions> optionsAccessor, IInlineConstraintResolver constraintResolver, IModelMetadataProvider modelMetadataProvider)

Properties

Order()
Return type:System.Int32
public int Order { get; }

Methods

OnProvidersExecuted(Microsoft.AspNet.Mvc.ApiExplorer.ApiDescriptionProviderContext)
Arguments:
public void OnProvidersExecuted(ApiDescriptionProviderContext context)
OnProvidersExecuting(Microsoft.AspNet.Mvc.ApiExplorer.ApiDescriptionProviderContext)
Arguments:
public void OnProvidersExecuting(ApiDescriptionProviderContext context)