Skip to content
Documentation

IDocumentationConfiguration Interface

Defines how automatically generated OpenAPI documentation should be hosted within a service.

public interface IDocumentationConfiguration

IDocumentationConfiguration.BasePath Property

Section titled “IDocumentationConfiguration.BasePath Property”

The path under which the OpenAPI documents should be hosted.

HAKOM.Documentation.Http.Net.Api.IDocumentationBasePath BasePath { get; }

IDocumentationBasePath

IDocumentationConfiguration.CurrentVersion Property

Section titled “IDocumentationConfiguration.CurrentVersion Property”

The current version of the service to be documented.

HAKOM.Versioning.Core.Net.Api.IVersion? CurrentVersion { get; }

IVersion

IDocumentationConfiguration.FileNamePrefix Property

Section titled “IDocumentationConfiguration.FileNamePrefix Property”

The name of the generated document. This will be suffixed with the appropriate version.

HAKOM.Documentation.Http.Net.Api.IDocumentationFileNamePrefix FileNamePrefix { get; }

IDocumentationFileNamePrefix

IDocumentationConfiguration.SupportedVersions Property

Section titled “IDocumentationConfiguration.SupportedVersions Property”

A list of all API versions that the service supports.

System.Collections.Generic.IEnumerable<HAKOM.Versioning.Core.Net.Api.IVersion>? SupportedVersions { get; }

System.Collections.Generic.IEnumerable<IVersion>

A separate OpenAPI document will be generated for each one of these.

IDocumentationConfiguration.VersionSeparator Property

Section titled “IDocumentationConfiguration.VersionSeparator Property”

A string that separates the FileNamePrefix from the version of the document.

HAKOM.Documentation.Http.Net.Api.IDocumentationVersionSeparator VersionSeparator { get; }

IDocumentationVersionSeparator

IDocumentationConfiguration.GetFileNameForDefaultDocument() Method

Section titled “IDocumentationConfiguration.GetFileNameForDefaultDocument() Method”

Gets the full file name for the default document including its extension (but without the BasePath).

string GetFileNameForDefaultDocument();

System.String
The file name for the default document.

IDocumentationConfiguration.GetFileNamesForVersionedDocuments() Method

Section titled “IDocumentationConfiguration.GetFileNamesForVersionedDocuments() Method”

Gets the full file names for all the generated documents including the extension (but without the BasePath).

System.Collections.Generic.IEnumerable<(string Version,string FileName)> GetFileNamesForVersionedDocuments();

System.Collections.Generic.IEnumerable<<System.String,System.String>>
The file name for each generated document.

© 2026 Volue.Version v0.6.38017 November 2026