Sisk

Namespace

Sisk.Documenting

Namespace
Sisk.Documenting

Namespaces #

NameDescription
Sisk.Documenting.Annotations
Sisk.Documenting.Content
Sisk.Documenting.Exporters
Sisk.Documenting.Html

Classes #

NameDescription
ApiDocumentationRepresents the API documentation, including application details and endpoints.
ApiDocumentationBuilderExtensionsProvides extension methods for configuring API documentation generation and exposure on an HTTP server host.
ApiDocumentationHandlerProvides hooks for filtering and customizing generated API documentation.
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.
ApiEndpointParameterExampleRepresents an example value for a request parameter in a specific situation.
ApiEndpointPathParameterRepresents a path parameter for an API endpoint, including its name, type, and description.
ApiEndpointQueryParameterRepresents a query 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.
ApiGenerationContextProvides context information used during API generation, such as application metadata and handlers for generating example bodies and parameters.

Type to search the documentation and the API reference.