HelpPageConfigurationExtensions Methods
The following tables list the members exposed by the HelpPageConfigurationExtensions type.
| Name | Description | |
|---|---|---|
|
GetHelpPageApiModel(this HttpConfiguration, string) | 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(this HttpConfiguration) | Gets the help page sample generator. |
|
|
GetModelDescriptionGenerator(this HttpConfiguration) | Gets the model description generator. |
|
|
SetActualRequestType(this HttpConfiguration, Type, string, string) | Specifies the actual type of ObjectContent<T> passed to the HttpRequestMessage in an action. The help page will use this information to produce more accurate request samples. |
|
|
SetActualRequestType(this HttpConfiguration, Type, string, string, params string[]) | Specifies the actual type of ObjectContent<T> passed to the HttpRequestMessage in an action. The help page will use this information to produce more accurate request samples. |
|
|
SetActualResponseType(this HttpConfiguration, Type, string, string) | Specifies the actual type of ObjectContent<T> returned as part of the HttpRequestMessage in an action. The help page will use this information to produce more accurate response samples. |
|
|
SetActualResponseType(this HttpConfiguration, Type, string, string, params string[]) | Specifies the actual type of ObjectContent<T> returned as part of the HttpRequestMessage in an action. The help page will use this information to produce more accurate response samples. |
|
|
SetDocumentationProvider(this HttpConfiguration, IDocumentationProvider) | Sets the documentation provider for help page. |
|
|
SetHelpPageSampleGenerator(this HttpConfiguration, HelpPageSampleGenerator) | Sets the help page sample generator. |
|
|
SetSampleForMediaType(this HttpConfiguration, object, MediaTypeHeaderValue) | Sets the sample directly for all actions with the specified media type. |
|
|
SetSampleForType(this HttpConfiguration, object, MediaTypeHeaderValue, Type) | Sets the sample directly for all actions with the specified type and media type. |
|
|
SetSampleObjects(this HttpConfiguration, IDictionary<TypeObject>) | Sets the objects that will be used by the formatters to produce sample requests/responses. |
|
|
SetSampleRequest(this HttpConfiguration, object, MediaTypeHeaderValue, string, string) | Sets the sample request directly for the specified media type and action. |
|
|
SetSampleRequest(this HttpConfiguration, object, MediaTypeHeaderValue, string, string, params string[]) | Sets the sample request directly for the specified media type and action with parameters. |
|
|
SetSampleResponse(this HttpConfiguration, object, MediaTypeHeaderValue, string, string) | Sets the sample request directly for the specified media type of the action. |
|
|
SetSampleResponse(this HttpConfiguration, object, MediaTypeHeaderValue, string, string, params string[]) | Sets the sample response directly for the specified media type of the action with specific parameters. |