Interface IDocumentationProvider

Namespace

System.Web.Http.Description

Assembly

System.Web.Http.dll

Defines the provider responsible for documenting the service.

public interface IDocumentationProvider

Methods

GetDocumentation(HttpActionDescriptor)

Gets the documentation based on HttpActionDescriptor.

string GetDocumentation(HttpActionDescriptor actionDescriptor)

Parameters

actionDescriptor HttpActionDescriptor

The action descriptor.

Returns

string

The documentation for the controller.

GetDocumentation(HttpParameterDescriptor)

Gets the documentation based on HttpParameterDescriptor.

string GetDocumentation(HttpParameterDescriptor parameterDescriptor)

Parameters

parameterDescriptor HttpParameterDescriptor

The parameter descriptor.

Returns

string

The documentation for the controller.