Skip to content
Documentation

HAKOM.Documentation.Http.Net Assembly

Provides automatic OpenAPI documentation generation and hosting for HAKOM HTTP services.

The HAKOM.Documentation.Http.Net assembly integrates Swashbuckle (Swagger) into ASP.NET Core services built on the HAKOM HTTP infrastructure. It generates versioned OpenAPI specification documents, applies custom Swagger UI styling and adds several Swashbuckle filters that improve the quality of generated specifications.

Getting started

Call AddDocumentation(this IMvcBuilder, string, string, string, string, string, string, Action<SwaggerGenOptions>) during service setup and UseDocumentation(this WebApplication, Action<SwaggerOptions>) on the built application.

protected override void ConfigureMvc(IMvcBuilder mvcBuilder)
{
mvcBuilder.AddDocumentation(
title: "My API",
description: "Manages time series data."
);
}
protected override void ConfigureApplication(WebApplication application)
{
base.ConfigureApplication(application);
application.UseDocumentation();
}
Key components
Namespaces
HAKOM.Documentation.Http.Net.Api Contains the public API surface for configuring and hosting OpenAPI documentation in HAKOM HTTP services.
HAKOM.Documentation.Http.Net.Api.Exceptions Contains exception types raised by the documentation infrastructure during service startup.
HAKOM.Documentation.Http.Net.Api.Extensions Provides extension methods for adding and configuring automatically generated OpenAPI documentation.
© 2026 Volue.Version v0.6.38017 November 2026