Method | Description | |
---|---|---|
GetActionSample ( string controllerName, string actionName, IEnumerable |
Search for samples that are provided directly through ActionSamples.
|
|
GetSample ( System.Web.Http.Description.ApiDescription api, SampleDirection sampleDirection ) : object>.IDictionary |
Gets the request or response body samples.
|
|
GetSampleObject ( |
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 ObjectGenerator.
|
|
GetSampleRequests ( System.Web.Http.Description.ApiDescription api ) : object>.IDictionary |
Gets the request body samples for a given ApiDescription.
|
|
GetSampleResponses ( System.Web.Http.Description.ApiDescription api ) : object>.IDictionary |
Gets the response body samples for a given ApiDescription.
|
|
HelpPageSampleGenerator ( ) : System |
Initializes a new instance of the HelpPageSampleGenerator class.
|
Method | Description | |
---|---|---|
GetAllActionSamples ( string controllerName, string actionName, IEnumerable |
||
IsFormatSupported ( SampleDirection sampleDirection, System.Net.Http.Formatting.MediaTypeFormatter formatter, |
||
ResolveType ( System.Web.Http.Description.ApiDescription api, string controllerName, string actionName, IEnumerable |
||
TryFormatJson ( string str ) : string | ||
TryFormatXml ( string str ) : string | ||
WrapSampleIfString ( object sample ) : object | ||
WriteSampleObjectUsingFormatter ( MediaTypeFormatter formatter, object value, Type type, MediaTypeHeaderValue mediaType ) : object |
public GetActionSample ( string controllerName, string actionName, IEnumerable |
||
controllerName | string | Name of the controller. |
actionName | string | Name of the action. |
parameterNames | IEnumerable |
The parameter names. |
type | The CLR type. | |
formatter | System.Net.Http.Formatting.MediaTypeFormatter | The formatter. |
mediaType | The media type. | |
sampleDirection | SampleDirection | The value indicating whether the sample is for a request or for a response. |
return | object |
public GetSample ( System.Web.Http.Description.ApiDescription api, SampleDirection sampleDirection ) : object>.IDictionary |
||
api | System.Web.Http.Description.ApiDescription | The |
sampleDirection | SampleDirection | The value indicating whether the sample is for a request or for a response. |
return | object>.IDictionary |
public GetSampleObject ( |
||
type | The type. | |
return | object |
public GetSampleRequests ( System.Web.Http.Description.ApiDescription api ) : object>.IDictionary |
||
api | System.Web.Http.Description.ApiDescription | The |
return | object>.IDictionary |
public GetSampleResponses ( System.Web.Http.Description.ApiDescription api ) : object>.IDictionary |
||
api | System.Web.Http.Description.ApiDescription | The |
return | object>.IDictionary |