The model that represents an API displayed on the help page.
Inheritance Hierarchy
RainWorx.FrameWorx.MVC.Areas.HelpPage.ModelsHelpPageApiModel
Namespace: RainWorx.FrameWorx.MVC.Areas.HelpPage.Models
Assembly: RainWorx.FrameWorx.MVC (in RainWorx.FrameWorx.MVC.dll) Version: 3.5
Syntax
C#
public class HelpPageApiModel
The HelpPageApiModel type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | HelpPageApiModel |
Initializes a new instance of the HelpPageApiModel class.
|
Properties
| Name | Description | |
|---|---|---|
 | ApiDescription |
Gets or sets the ApiDescription that describes the API.
|
| ErrorMessages |
Gets the error messages associated with this model.
|
| SampleRequests |
Gets the sample requests associated with the API.
|
| SampleResponses |
Gets the sample responses associated with the API.
|
Extension Methods
| Name | Description | |
|---|---|---|
 | ToMvcHtmlString |
Returns the HTML version of the ToString() output method of the specified object
(Defined by HtmlHelpers.) |
See Also