Share via


ApiDescription Class

Definition

Represents an API exposed by this application.

public ref class ApiDescription
public class ApiDescription
type ApiDescription = class
Public Class ApiDescription
Inheritance
ApiDescription

Constructors

ApiDescription()

Properties

ActionDescriptor

Gets or sets ActionDescriptor for this api.

GroupName

Gets or sets group name for this api.

HttpMethod

Gets or sets the supported HTTP method for this api, or null if all HTTP methods are supported.

ParameterDescriptions

Gets a list of ApiParameterDescription for this api.

Properties

Gets arbitrary metadata properties associated with the ApiDescription.

RelativePath

Gets or sets relative url path template (relative to application root) for this api.

SupportedRequestFormats

Gets the list of possible formats for a request.

SupportedResponseTypes

Gets the list of possible formats for a response.

Extension Methods

GetProperty<T>(ApiDescription)

Gets the value of a property from the Properties collection using the provided value of T as the key.

SetProperty<T>(ApiDescription, T)

Sets the value of an property in the Properties collection using the provided value of T as the key.

Applies to