HelpPageConfigurationExtensions Class

Public Class HelpPageConfigurationExtensions
This language is not supported or no code example is available.
public static class HelpPageConfigurationExtensions
This language is not supported or no code example is available.
public ref class HelpPageConfigurationExtensions 
This language is not supported or no code example is available.
public class HelpPageConfigurationExtensions
This language is not supported or no code example is available.
Methods
 
Name Description
Public method Static 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.
Public method Static GetHelpPageSampleGenerator(this HttpConfiguration) Gets the help page sample generator.
Public method Static GetModelDescriptionGenerator(this HttpConfiguration) Gets the model description generator.
Public method Static 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.
Public method Static 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.
Public method Static 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.
Public method Static 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.
Public method Static SetDocumentationProvider(this HttpConfiguration, IDocumentationProvider) Sets the documentation provider for help page.
Public method Static SetHelpPageSampleGenerator(this HttpConfiguration, HelpPageSampleGenerator) Sets the help page sample generator.
Public method Static SetSampleForMediaType(this HttpConfiguration, object, MediaTypeHeaderValue) Sets the sample directly for all actions with the specified media type.
Public method Static SetSampleForType(this HttpConfiguration, object, MediaTypeHeaderValue, Type) Sets the sample directly for all actions with the specified type and media type.
Public method Static SetSampleObjects(this HttpConfiguration, IDictionary<TypeObject>) Sets the objects that will be used by the formatters to produce sample requests/responses.
Public method Static SetSampleRequest(this HttpConfiguration, object, MediaTypeHeaderValue, string, string) Sets the sample request directly for the specified media type and action.
Public method Static SetSampleRequest(this HttpConfiguration, object, MediaTypeHeaderValue, string, string, params string[]) Sets the sample request directly for the specified media type and action with parameters.
Public method Static SetSampleResponse(this HttpConfiguration, object, MediaTypeHeaderValue, string, string) Sets the sample request directly for the specified media type of the action.
Public method Static 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.
Top

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8

In this article

Definition