API_NetFramework.Areas.HelpPage Namespace


Assembly: EDOKAAPI_NetFramework (in EDOKAAPI_NetFramework.dll)
Classes
 
Name Description
Public class Static ApiDescriptionExtensions
Public class HelpPageAreaRegistration
Public class Static HelpPageConfig Use this class to customize the Help Page. For example you can set a custom IDocumentationProvider to supply the documentation or you can provide the samples for the requests/responses.
Public class Static HelpPageConfigurationExtensions
Public class HelpPageSampleGenerator This class will generate the samples for the help page.
Public class HelpPageSampleKey This is used to identify the place where the sample should be applied.
Public class ImageSample This represents an image sample on the help page. There's a display template named ImageSample associated with this class.
Public class InvalidSample This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.
Public class ObjectGenerator This class will create an object of a given type and populate it with sample data.
Public class TextSample This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.
Public class XmlDocumentationProvider A custom IDocumentationProvider that reads the API documentation from an XML documentation file.
Top
Enumerations
 
Name Description
Public enumeration SampleDirection Indicates whether the sample is used for request or response
Top
Applies to
 

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8

In this article

Definition