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
System_CAPS_pubmethod ApiDescription()

Initializes a new instance of the ApiDescription class.

Properties

Name Description
System_CAPS_pubproperty ActionDescriptor

Gets or sets the action descriptor that will handle the API.

System_CAPS_pubproperty Documentation

Gets or sets the documentation of the API.

System_CAPS_pubproperty HttpMethod

Gets or sets the HTTP method.

System_CAPS_pubproperty ID

Gets the ID. The ID is unique within HttpServer.

System_CAPS_pubproperty ParameterDescriptions

Gets the parameter descriptions.

System_CAPS_pubproperty RelativePath

Gets or sets the relative path.

System_CAPS_pubproperty ResponseDescription

Gets or sets the response description.

System_CAPS_pubproperty Route

Gets or sets the registered route for the API.

System_CAPS_pubproperty SupportedRequestBodyFormatters

Gets the supported request body formatters.

System_CAPS_pubproperty SupportedResponseFormatters

Gets the supported response formatters.

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 GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

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