ApiExplorer.ShouldExploreController Method (String, HttpControllerDescriptor, IHttpRoute)

 

Determines whether the controller should be considered for ApiDescriptions generation. Called when initializing the ApiDescriptions.

Namespace:   System.Web.Http.Description
Assembly:  System.Web.Http (in System.Web.Http.dll)

Syntax

public virtual bool ShouldExploreController(
    string controllerVariableValue,
    HttpControllerDescriptor controllerDescriptor,
    IHttpRoute route
)

public:
virtual bool ShouldExploreController(
    String^ controllerVariableValue,
    HttpControllerDescriptor^ controllerDescriptor,
    IHttpRoute^ route
)

abstract ShouldExploreController : 
        controllerVariableValue:string *
        controllerDescriptor:HttpControllerDescriptor *
        route:IHttpRoute -> bool
override ShouldExploreController : 
        controllerVariableValue:string *
        controllerDescriptor:HttpControllerDescriptor *
        route:IHttpRoute -> bool

Public Overridable Function ShouldExploreController (
    controllerVariableValue As String,
    controllerDescriptor As HttpControllerDescriptor,
    route As IHttpRoute
) As Boolean

Parameters

• controllerVariableValue
  Type: System.String

  The controller variable value from the route.

• controllerDescriptor
  Type: System.Web.Http.Controllers.HttpControllerDescriptor

  The controller descriptor.

• route
  Type: System.Web.Http.Routing.IHttpRoute

  The route.

Return Value

Type: System.Boolean

true if the controller should be considered for ApiDescriptions generation, false otherwise.

See Also

ApiExplorer Class
System.Web.Http.Description Namespace

Return to top