Share via


ApiExplorer Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class ApiExplorer _
    Implements IApiExplorer
'Usage
Dim instance As ApiExplorer
public class ApiExplorer : IApiExplorer
public ref class ApiExplorer : IApiExplorer
type ApiExplorer =  
    class 
        interface IApiExplorer 
    end
public class ApiExplorer implements IApiExplorer

The ApiExplorer type exposes the following members.

Constructors

  Name Description
Public method ApiExplorer Initializes a new instance of the ApiExplorer class.

Top

Properties

  Name Description
Public property ApiDescriptions Gets the API descriptions. The descriptions are initialized on the first access.
Public property DocumentationProvider Gets or sets the documentation provider. The provider will be responsible for documenting the API.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetHttpMethodsSupportedByAction Gets a collection of HttpMethods supported by the action. Called when initializing the ApiDescriptions.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ShouldExploreAction Determines whether the action should be considered for ApiDescriptions generation. Called when initializing the ApiDescriptions.
Public method ShouldExploreController Determines whether the controller should be considered for ApiDescriptions generation. Called when initializing the ApiDescriptions.
Public method ToString (Inherited from Object.)

Top

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

Reference

System.Web.Http.Description Namespace