Share via


ApiExplorer Class

 

Explores the URI space of the service based on routes, controllers and actions available in the system.

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

Inheritance Hierarchy

System.Object
  System.Web.Http.Description.ApiExplorer

Syntax

public class ApiExplorer : IApiExplorer
public ref class ApiExplorer : IApiExplorer
type ApiExplorer = 
    class
        interface IApiExplorer
    end
Public Class ApiExplorer
    Implements IApiExplorer

Constructors

Name Description
System_CAPS_pubmethod ApiExplorer(HttpConfiguration)

Initializes a new instance of the ApiExplorer class.

Properties

Name Description
System_CAPS_pubproperty ApiDescriptions

Gets the API descriptions. The descriptions are initialized on the first access.

System_CAPS_pubproperty DocumentationProvider

Gets or sets the documentation provider. The provider will be responsible for documenting the API.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetHttpMethodsSupportedByAction(IHttpRoute, HttpActionDescriptor)

Gets a collection of HttpMethods supported by the action. Called when initializing the ApiDescriptions.

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ShouldExploreAction(String, HttpActionDescriptor, IHttpRoute)

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

System_CAPS_pubmethod ShouldExploreController(String, HttpControllerDescriptor, IHttpRoute)

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

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

System.Web.Http.Description Namespace

Return to top