Class ApiDocumentation

Namespace

Sisk.Documenting

Assembly

Sisk.Documenting.dll

Represents the API documentation, including application details and endpoints.

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

ApiVersion

Gets or sets the version of the API.

ApplicationDescription

Gets or sets the description of the application.

ApplicationName

Gets or sets the name of the application.

Endpoints

Gets or sets the array of API endpoints.

Methods

Generate(Router, ApiIdentifier)

Generates an instance of ApiDocumentation by reading documentation from the specified router and identifier.