C# Class SpaStack.NET.Areas.HelpPage.HelpPageConfigurationExtensions

Exibir arquivo Open project: ntheile/SpaStack.NET

Public Methods

Method Description
GetHelpPageApiModel ( this config, string apiDescriptionId ) : HelpPageApiModel

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 ) : HelpPageSampleGenerator

Gets the help page sample generator.

SetActualRequestType ( this config, Type type, string controllerName, string actionName ) : void

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, Type type, string controllerName, string actionName ) : void

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, HelpPageSampleGenerator sampleGenerator ) : void

Sets the help page sample generator.

SetSampleForType ( this config, object sample, MediaTypeHeaderValue mediaType, Type type ) : void

Sets the sample directly for all actions with the specified type and media type.

SetSampleObjects ( this config, object>.IDictionary sampleObjects ) : void

Sets the objects that will be used by the formatters to produce sample requests/responses.

SetSampleRequest ( this config, object sample, MediaTypeHeaderValue mediaType, string controllerName, string actionName ) : void

Sets the sample request directly for the specified media type and action.

SetSampleResponse ( this config, object sample, MediaTypeHeaderValue mediaType, string controllerName, string actionName ) : void

Sets the sample request directly for the specified media type of the action.

Private Methods

Method Description
GenerateApiModel ( System.Web.Http.Description.ApiDescription apiDescription, HelpPageSampleGenerator sampleGenerator ) : HelpPageApiModel
LogInvalidSampleAsError ( HelpPageApiModel apiModel, object sample ) : void

Method Details

GetHelpPageApiModel() public static method

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 static GetHelpPageApiModel ( this config, string apiDescriptionId ) : HelpPageApiModel
config this The .
apiDescriptionId string The ID.
return SpaStack.NET.Areas.HelpPage.Models.HelpPageApiModel

GetHelpPageSampleGenerator() public static method

Gets the help page sample generator.
public static GetHelpPageSampleGenerator ( this config ) : HelpPageSampleGenerator
config this The .
return HelpPageSampleGenerator

SetActualRequestType() public static method

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.
public static SetActualRequestType ( this config, Type type, string controllerName, string actionName ) : void
config this The .
type System.Type The type.
controllerName string Name of the controller.
actionName string Name of the action.
return void

SetActualResponseType() public static method

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.
public static SetActualResponseType ( this config, Type type, string controllerName, string actionName ) : void
config this The .
type System.Type The type.
controllerName string Name of the controller.
actionName string Name of the action.
return void

SetDocumentationProvider() public static method

Sets the documentation provider for help page.
public static SetDocumentationProvider ( this config, IDocumentationProvider documentationProvider ) : void
config this The .
documentationProvider IDocumentationProvider The documentation provider.
return void

SetHelpPageSampleGenerator() public static method

Sets the help page sample generator.
public static SetHelpPageSampleGenerator ( this config, HelpPageSampleGenerator sampleGenerator ) : void
config this The .
sampleGenerator HelpPageSampleGenerator The help page sample generator.
return void

SetSampleForType() public static method

Sets the sample directly for all actions with the specified type and media type.
public static SetSampleForType ( this config, object sample, MediaTypeHeaderValue mediaType, Type type ) : void
config this The .
sample object The sample.
mediaType System.Net.Http.Headers.MediaTypeHeaderValue The media type.
type System.Type The parameter type or return type of an action.
return void

SetSampleObjects() public static method

Sets the objects that will be used by the formatters to produce sample requests/responses.
public static SetSampleObjects ( this config, object>.IDictionary sampleObjects ) : void
config this The .
sampleObjects object>.IDictionary The sample objects.
return void

SetSampleRequest() public static method

Sets the sample request directly for the specified media type and action.
public static SetSampleRequest ( this config, object sample, MediaTypeHeaderValue mediaType, string controllerName, string actionName ) : void
config this The .
sample object The sample request.
mediaType System.Net.Http.Headers.MediaTypeHeaderValue The media type.
controllerName string Name of the controller.
actionName string Name of the action.
return void

SetSampleResponse() public static method

Sets the sample request directly for the specified media type of the action.
public static SetSampleResponse ( this config, object sample, MediaTypeHeaderValue mediaType, string controllerName, string actionName ) : void
config this The .
sample object The sample response.
mediaType System.Net.Http.Headers.MediaTypeHeaderValue The media type.
controllerName string Name of the controller.
actionName string Name of the action.
return void