Describes an API defined by relative URI path and HTTP method.
Inheritance Hierarchy
System.Object
System.Web.Http.Description.ApiDescription
Namespace: System.Web.Http.Description
Assembly: System.Web.Http (in System.Web.Http.dll)
Syntax
'Declaration
Public Class ApiDescription
'Usage
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.
Constructors
| Name | Description | |
|---|---|---|
.jpeg "Public method") |
ApiDescription | Initializes a new instance of the ApiDescription class. |
Top
Properties
| Name | Description | |
|---|---|---|
.jpeg "Public property") |
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. |
|
Route | Gets or sets the registered route for the API. |
|
SupportedRequestBodyFormatters | Gets the supported request body formatters. |
|
SupportedResponseFormatters | Gets the supported response formatters. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
.jpeg "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
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.