Class ApiDescription

Namespace

System.Web.Http.Description

Assembly

System.Web.Http.dll

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

public class ApiDescription

Inheritance

object

ApiDescription

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiDescription()

Initializes a new instance of the ApiDescription class.

public ApiDescription()

Properties

ActionDescriptor

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

public HttpActionDescriptor ActionDescriptor { get; set; }

Property Value

HttpActionDescriptor

The action descriptor.

Documentation

Gets or sets the documentation of the API.

public string Documentation { get; set; }

Property Value

string

The documentation.

HttpMethod

Gets or sets the HTTP method.

public HttpMethod HttpMethod { get; set; }

Property Value

HttpMethod

The HTTP method.

ID

Gets the ID. The ID is unique within HttpServer.

public string ID { get; }

Property Value

string

ParameterDescriptions

Gets the parameter descriptions.

public Collection<ApiParameterDescription> ParameterDescriptions { get; }

Property Value

Collection<ApiParameterDescription>

RelativePath

Gets or sets the relative path.

public string RelativePath { get; set; }

Property Value

string

The relative path.

Route

Gets or sets the registered route for the API.

public IHttpRoute Route { get; set; }

Property Value

IHttpRoute

The route.

SupportedRequestBodyFormatters

Gets the supported request body formatters.

public Collection<MediaTypeFormatter> SupportedRequestBodyFormatters { get; }

Property Value

Collection<MediaTypeFormatter>

SupportedResponseFormatters

Gets the supported response formatters.

public Collection<MediaTypeFormatter> SupportedResponseFormatters { get; }

Property Value

Collection<MediaTypeFormatter>