Table of Contents

Namespace Sisk.Documenting

Namespaces

Sisk.Documenting.Annotations
Sisk.Documenting.Html

Classes

ApiDocumentation

Represents the API documentation, including application details and endpoints.

ApiEndpoint

Represents an API endpoint, including its metadata, request and response details.

ApiEndpointHeader

Represents a header for an API endpoint, including its name and requirements.

ApiEndpointParameter

Represents a parameter for an API endpoint, including its name, type, and requirements.

ApiEndpointPathParameter

Represents a path parameter for an API endpoint, including its name, type, and description.

ApiEndpointRequestExample

Represents an example request for an API endpoint, including its description and example content.

ApiEndpointResponse

Represents a response for an API endpoint, including the status code and example content.

ApiIdentifier

Represents an identifier for an API, including application details such as name, version, and description.

Interfaces

IApiDocumentationExporter

Defines a contract for exporting API documentation content.