Method | Description | |
---|---|---|
GetHelpPageApiModel ( this config, string apiDescriptionId ) : |
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 config ) : |
Gets the help page sample generator.
|
|
GetModelDescriptionGenerator ( this config ) : |
Gets the model description generator.
|
|
SetActualRequestType ( this config, |
Specifies the actual type of System.Net.Http.ObjectContent{T} passed to the System.Net.Http.HttpRequestMessage in an action. The help page will use this information to produce more accurate request samples.
|
|
SetActualResponseType ( this config, |
Specifies the actual type of System.Net.Http.ObjectContent{T} returned as part of the System.Net.Http.HttpRequestMessage in an action. The help page will use this information to produce more accurate response samples.
|
|
SetDocumentationProvider ( this config, IDocumentationProvider documentationProvider ) : void |
Sets the documentation provider for help page.
|
|
SetHelpPageSampleGenerator ( this config, |
Sets the help page sample generator.
|
|
SetSampleForMediaType ( this config, object sample, |
Sets the sample directly for all actions with the specified media type.
|
|
SetSampleForType ( this config, object sample, |
Sets the sample directly for all actions with the specified type and media type.
|
|
SetSampleObjects ( this config, object>.IDictionary |
Sets the objects that will be used by the formatters to produce sample requests/responses.
|
|
SetSampleRequest ( this config, object sample, |
Sets the sample request directly for the specified media type and action.
|
|
SetSampleResponse ( this config, object sample, |
Sets the sample request directly for the specified media type of the action.
|
Method | Description | |
---|---|---|
AddParameterDescription ( |
||
GenerateApiModel ( System.Web.Http.Description.ApiDescription apiDescription, System.Web.Http.HttpConfiguration config ) : |
||
GenerateRequestModelDescription ( |
||
GenerateResourceDescription ( |
||
GenerateSamples ( |
||
GenerateUriParameters ( |
||
InitializeModelDescriptionGenerator ( System.Web.Http.HttpConfiguration config ) : |
||
IsBindableWithTypeConverter ( |
||
LogInvalidSampleAsError ( |
||
TryGetResourceParameter ( System.Web.Http.Description.ApiDescription apiDescription, System.Web.Http.HttpConfiguration config, System.Web.Http.Description.ApiParameterDescription ¶meterDescription, |
public static GetHelpPageApiModel ( this config, string apiDescriptionId ) : |
||
config | this | The |
apiDescriptionId | string | The |
return |
public static GetHelpPageSampleGenerator ( this config ) : |
||
config | this | The |
return |
public static GetModelDescriptionGenerator ( this config ) : |
||
config | this | The configuration. |
return |
public static SetActualRequestType ( this config, |
||
config | this | The |
type | The type. | |
controllerName | string | Name of the controller. |
actionName | string | Name of the action. |
return | void |
public static SetActualResponseType ( this config, |
||
config | this | The |
type | The type. | |
controllerName | string | Name of the controller. |
actionName | string | Name of the action. |
return | void |
public static SetDocumentationProvider ( this config, IDocumentationProvider documentationProvider ) : void | ||
config | this | The |
documentationProvider | IDocumentationProvider | The documentation provider. |
return | void |
public static SetHelpPageSampleGenerator ( this config, |
||
config | this | The |
sampleGenerator | The help page sample generator. | |
return | void |
public static SetSampleForMediaType ( this config, object sample, |
||
config | this | The |
sample | object | The sample. |
mediaType | The media type. | |
return | void |
public static SetSampleForType ( this config, object sample, |
||
config | this | The |
sample | object | The sample. |
mediaType | The media type. | |
type | The parameter type or return type of an action. | |
return | void |
public static SetSampleObjects ( this config, object>.IDictionary |
||
config | this | The |
sampleObjects | object>.IDictionary | The sample objects. |
return | void |
public static SetSampleRequest ( this config, object sample, |
||
config | this | The |
sample | object | The sample request. |
mediaType | The media type. | |
controllerName | string | Name of the controller. |
actionName | string | Name of the action. |
return | void |
public static SetSampleResponse ( this config, object sample, |
||
config | this | The |
sample | object | The sample response. |
mediaType | The media type. | |
controllerName | string | Name of the controller. |
actionName | string | Name of the action. |
return | void |