IDocumentationConfiguration Interface
Defines how automatically generated OpenAPI documentation should be hosted within a service.
public interface IDocumentationConfigurationProperties
Section titled “Properties”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; }Property Value
Section titled “Property Value”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; }Property Value
Section titled “Property Value”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; }Property Value
Section titled “Property Value”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; }Property Value
Section titled “Property Value”System.Collections.Generic.IEnumerable<IVersion>
Remarks
Section titled “Remarks”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; }Property Value
Section titled “Property Value”IDocumentationVersionSeparator
Methods
Section titled “Methods”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();Returns
Section titled “Returns”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();Returns
Section titled “Returns”System.Collections.Generic.IEnumerable<<System.String,System.String>>
The file name for each generated document.