HelpPageConfigurationExtensions Members
The HelpPageConfigurationExtensions type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
GetHelpPageApiModel |
Gets the model that represents an API displayed on the help page. The model is initialized on the first call and cached for subsequent calls.
|
|
|
GetHelpPageSampleGenerator |
Gets the help page sample generator.
|
|
|
GetModelDescriptionGenerator |
Gets the model description generator.
|
|
|
SetActualRequestType(HttpConfiguration, Type, String, String) |
Specifies the actual type of ObjectContent passed to the HttpRequestMessage in an action.
The help page will use this information to produce more accurate request samples.
|
|
|
SetActualRequestType(HttpConfiguration, Type, String, String, array<String>[]()[][]) |
Specifies the actual type of ObjectContent passed to the HttpRequestMessage in an action.
The help page will use this information to produce more accurate request samples.
|
|
|
SetActualResponseType(HttpConfiguration, Type, String, String) |
Specifies the actual type of ObjectContent returned as part of the HttpRequestMessage in an action.
The help page will use this information to produce more accurate response samples.
|
|
|
SetActualResponseType(HttpConfiguration, Type, String, String, array<String>[]()[][]) |
Specifies the actual type of ObjectContent returned as part of the HttpRequestMessage in an action.
The help page will use this information to produce more accurate response samples.
|
|
|
SetDocumentationProvider |
Sets the documentation provider for help page.
|
|
|
SetHelpPageSampleGenerator |
Sets the help page sample generator.
|
|
|
SetSampleForMediaType |
Sets the sample directly for all actions with the specified media type.
|
|
|
SetSampleForType |
Sets the sample directly for all actions with the specified type and media type.
|
|
|
SetSampleObjects |
Sets the objects that will be used by the formatters to produce sample requests/responses.
|
|
|
SetSampleRequest(HttpConfiguration, Object, MediaTypeHeaderValue, String, String) |
Sets the sample request directly for the specified media type and action.
|
|
|
SetSampleRequest(HttpConfiguration, Object, MediaTypeHeaderValue, String, String, array<String>[]()[][]) |
Sets the sample request directly for the specified media type and action with parameters.
|
|
|
SetSampleResponse(HttpConfiguration, Object, MediaTypeHeaderValue, String, String) |
Sets the sample request directly for the specified media type of the action.
|
|
|
SetSampleResponse(HttpConfiguration, Object, MediaTypeHeaderValue, String, String, array<String>[]()[][]) |
Sets the sample response directly for the specified media type of the action with specific parameters.
|