ApiDescription Class

 

Describes an API defined by relative URI path and HTTP method.

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

Inheritance Hierarchy

System.Object
  System.Web.Http.Description.ApiDescription

Syntax

public class ApiDescription

public ref class ApiDescription 

type ApiDescription = class end

Public Class ApiDescription

Constructors

	Name	Description
	ApiDescription()	Initializes a new instance of the ApiDescription class.

Properties

	Name	Description
	ActionDescriptor	Gets or sets the action descriptor that will handle the API.
	Documentation	Gets or sets the documentation of the API.
	HttpMethod	Gets or sets the HTTP method.
	ID	Gets the ID. The ID is unique within HttpServer.
	ParameterDescriptions	Gets the parameter descriptions.
	RelativePath	Gets or sets the relative path.
	ResponseDescription	Gets or sets the response description.
	Route	Gets or sets the registered route for the API.
	SupportedRequestBodyFormatters	Gets the supported request body formatters.
	SupportedResponseFormatters	Gets the supported response formatters.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	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