Skip to content
Documentation

DocumentationController Class

Provides documentation related endpoints.

public sealed class DocumentationController : Microsoft.AspNetCore.Mvc.Controller

Inheritance System.Object 🡒 Microsoft.AspNetCore.Mvc.ControllerBase 🡒 Microsoft.AspNetCore.Mvc.Controller 🡒 DocumentationController

DocumentationController.DEFAULT_DOCUMENT_VERSIONKEY Field

Section titled “DocumentationController.DEFAULT_DOCUMENT_VERSIONKEY Field”

The key that is used to refer to the default OpenAPI document.

public const string DEFAULT_DOCUMENT_VERSIONKEY = "default";

System.String

The list of available OpenAPI documents returned by GetAvailableDocuments(IDocumentationConfiguration) will always contain an entry with this key. The link under this key is the one that should be used by default and will be the one that the request will be redirected to.

DocumentationController.GetAvailableDocuments(IDocumentationConfiguration) Method

Section titled “DocumentationController.GetAvailableDocuments(IDocumentationConfiguration) Method”

Returns links to all OpenAPI specifications available for this service.

public System.Collections.Generic.IDictionary<string,System.Uri> GetAvailableDocuments(HAKOM.Documentation.Http.Net.Api.IDocumentationConfiguration documentationConfiguration);

documentationConfiguration IDocumentationConfiguration

An instance of IDocumentationConfiguration that specifies - among other things - the available versions.

System.Collections.Generic.IDictionary<System.String,System.Uri>
A dictionary in which each key represents a version number and each value holds the absolute URI to the specification.

DocumentationController.GetCustomSwaggerCss() Method

Section titled “DocumentationController.GetCustomSwaggerCss() Method”

Returns the custom CSS stylesheet used to style the Swagger UI.

public Microsoft.AspNetCore.Mvc.IActionResult GetCustomSwaggerCss();

Microsoft.AspNetCore.Mvc.IActionResult
The custom CSS file content.

DocumentationController.GetCustomSwaggerJs() Method

Section titled “DocumentationController.GetCustomSwaggerJs() Method”

Returns the custom JavaScript used to enhance the Swagger UI.

public Microsoft.AspNetCore.Mvc.IActionResult GetCustomSwaggerJs();

Microsoft.AspNetCore.Mvc.IActionResult
The custom JavaScript file content.

DocumentationController.GetFavicon16x16() Method

Section titled “DocumentationController.GetFavicon16x16() Method”

Returns the 16x16 pixel favicon image for the Swagger UI.

public Microsoft.AspNetCore.Mvc.IActionResult GetFavicon16x16();

Microsoft.AspNetCore.Mvc.IActionResult
The 16x16 favicon PNG image, or a 404 response if the embedded resource is not found.

DocumentationController.GetFavicon32x32() Method

Section titled “DocumentationController.GetFavicon32x32() Method”

Returns the 32x32 pixel favicon image for the Swagger UI.

public Microsoft.AspNetCore.Mvc.IActionResult GetFavicon32x32();

Microsoft.AspNetCore.Mvc.IActionResult
The 32x32 favicon PNG image, or a 404 response if the embedded resource is not found.

DocumentationController.GetRocket() Method

Section titled “DocumentationController.GetRocket() Method”

Returns the rocket logo image used in the Swagger UI top bar.

public Microsoft.AspNetCore.Mvc.IActionResult GetRocket();

Microsoft.AspNetCore.Mvc.IActionResult
The 64x64 rocket PNG image, or a 404 response if the embedded resource is not found.

DocumentationController.RedirectToDefaultDocument(IDocumentationConfiguration) Method

Section titled “DocumentationController.RedirectToDefaultDocument(IDocumentationConfiguration) Method”

Redirects to the default OpenAPI specification document for this version.

public void RedirectToDefaultDocument(HAKOM.Documentation.Http.Net.Api.IDocumentationConfiguration documentationConfiguration);

documentationConfiguration IDocumentationConfiguration

An instance of IDocumentationConfiguration that specifies - among other things - the available versions.

© 2026 Volue.Version v0.6.38017 November 2026