HelpPageSampleGenerator Methods
The following tables list the members exposed by the
HelpPageSampleGenerator
type.
|
Name
|
Description
|
|
GetActionSample(string, string, IEnumerable<String>, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection)
|
Search for samples that are provided directly through ActionSamples.
|
|
GetSample(ApiDescription, SampleDirection)
|
Gets the request or response body samples.
|
|
GetSampleObject(Type)
|
Gets the sample object that will be serialized by the formatters.
First, it will look at the SampleObjects. If no sample object is found, it will try to create
one using DefaultSampleObjectFactory (which wraps an ObjectGenerator) and other
factories in SampleObjectFactories.
|
|
GetSampleRequests(ApiDescription)
|
Gets the request body samples for a given ApiDescription.
|
|
GetSampleResponses(ApiDescription)
|
Gets the response body samples for a given ApiDescription.
|
|
ResolveHttpRequestMessageType(ApiDescription)
|
Resolves the actual type of ObjectContent<T> passed to the HttpRequestMessage in an action.
|
|
ResolveType(ApiDescription, string, string, IEnumerable<String>, SampleDirection, out Collection<MediaTypeFormatter>)
|
Resolves the type of the action parameter or return value when HttpRequestMessage or HttpResponseMessage is used.
|
|
WriteSampleObjectUsingFormatter(MediaTypeFormatter, object, Type, MediaTypeHeaderValue)
|
Writes the sample object using formatter.
|
Top
In this article
Definition