Sisk

Class

ApiDocumentation

Namespace
Sisk.Documenting
Assembly
Sisk.Documenting.dll

Represents the API documentation, including application details and endpoints.

C#
public sealed class ApiDocumentation

Inheritance #

object ← ApiDocumentation

Inherited Members #

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties #

NameDescription
ApiVersionGets or sets the version of the API.
ApplicationDescriptionGets or sets the description of the application.
ApplicationNameGets or sets the name of the application.
EndpointsGets or sets the array of API endpoints.

Methods #

NameDescription
Generate(Router, ApiIdentifier)Generates an instance of ApiDocumentation by reading documentation from the specified router and identifier.

Type to search the documentation and the API reference.