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
	ApiExplorer(HttpConfiguration)	Initializes a new instance of the ApiExplorer class.

Properties

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

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetHttpMethodsSupportedByAction(IHttpRoute, HttpActionDescriptor)	Gets a collection of HttpMethods supported by the action. Called when initializing the ApiDescriptions.
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ShouldExploreAction(String, HttpActionDescriptor, IHttpRoute)	Determines whether the action should be considered for ApiDescriptions generation. Called when initializing the ApiDescriptions.
	ShouldExploreController(String, HttpControllerDescriptor, IHttpRoute)	Determines whether the controller should be considered for ApiDescriptions generation. Called when initializing the ApiDescriptions.
	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