Sisk

Class

ApiDocumentationBuilderExtensions

Namespace
Sisk.Documenting
Assembly
Sisk.Documenting.dll

Provides extension methods for configuring API documentation generation and exposure on an HTTP server host.

C#
public static class ApiDocumentationBuilderExtensions

Inheritance #

object ← ApiDocumentationBuilderExtensions

Inherited Members #

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

Methods #

NameDescription
UseApiDocumentation(HttpServerHostContextBuilder, ApiGenerationContext, string, IApiDocumentationExporter?)Configures the application to expose generated API documentation at the specified router path.
UseApiDocumentation(HttpServerHostContextBuilder)Configures the application to expose generated API documentation at the default router path “/api/docs” using an empty ApiGenerationContext.

Type to search the documentation and the API reference.