ApiDescription Class

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

Inheritance Hierarchy


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


Public Class ApiDescription
Dim instance As ApiDescription
public class ApiDescription
public ref class ApiDescription
type ApiDescription =  class end
public class ApiDescription

The ApiDescription type exposes the following members.


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



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



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