Sisk

Namespace

Sisk.Documenting

Namespace
Sisk.Documenting

Namespaces #

NameDescription
Sisk.Documenting.Annotations
Sisk.Documenting.Html

Classes #

NameDescription
ApiDocumentationRepresents the API documentation, including application details and endpoints.
ApiEndpointRepresents an API endpoint, including its metadata, request and response details.
ApiEndpointHeaderRepresents a header for an API endpoint, including its name and requirements.
ApiEndpointParameterRepresents a parameter for an API endpoint, including its name, type, and requirements.
ApiEndpointPathParameterRepresents a path parameter for an API endpoint, including its name, type, and description.
ApiEndpointRequestExampleRepresents an example request for an API endpoint, including its description and example content.
ApiEndpointResponseRepresents a response for an API endpoint, including the status code and example content.
ApiIdentifierRepresents an identifier for an API, including application details such as name, version, and description.

Interfaces #

NameDescription
IApiDocumentationExporterDefines a contract for exporting API documentation content.

Type to search the documentation and the API reference.