Hlibz.OpenApi.AspNetCore
1.0.0
dotnet add package Hlibz.OpenApi.AspNetCore --version 1.0.0
NuGet\Install-Package Hlibz.OpenApi.AspNetCore -Version 1.0.0
<PackageReference Include="Hlibz.OpenApi.AspNetCore" Version="1.0.0" />
<PackageVersion Include="Hlibz.OpenApi.AspNetCore" Version="1.0.0" />
<PackageReference Include="Hlibz.OpenApi.AspNetCore" />
paket add Hlibz.OpenApi.AspNetCore --version 1.0.0
#r "nuget: Hlibz.OpenApi.AspNetCore, 1.0.0"
#:package Hlibz.OpenApi.AspNetCore@1.0.0
#addin nuget:?package=Hlibz.OpenApi.AspNetCore&version=1.0.0
#tool nuget:?package=Hlibz.OpenApi.AspNetCore&version=1.0.0
![]()
Hlibz.OpenApi.AspNetCore
Transformers for Microsoft.AspNetCore.OpenApi (AddOpenApi() / MapOpenApi()), for .NET 10
and 11.
dotnet add package Hlibz.OpenApi.AspNetCore
using Hlibz.OpenApi;
builder.Services.AddOpenApi("v1", options => options
.AddXmlDocumentation() // <summary>s as descriptions (enum values too), internal types and packages included
.AddOpenApiRules() // custom validation attributes describe themselves (IOpenApiRule)
.AddStronglyTypedIds() // CountryId(Guid Value) → { "type": "string", "format": "uuid" }
.AddValidationProblems() // the 400 AddValidation() answers with, where it can
.AddBearerSecurity() // a lock on exactly the endpoints that require authorization
.AddDescriptionCleanup()); // "Gets or sets the name." → "The name."
Several documents, one per endpoint group (WithGroupName(...)), configured once:
IReadOnlyList<OpenApiDocumentDefinition> documents = builder.Services.AddOpenApiDocuments(
[new("locations", "Locations"), new("locations-admin", "LocationsAdmin", "Locations (Admin)")],
(services, name, configure) => services.AddOpenApi(name, configure),
options => options.AddBearerSecurity());
AddXmlDocumentation() reads the XML file next to each assembly at runtime, so turn on
GenerateDocumentationFile in every project whose types you want described, and
CopyDocumentationFilesFromPackages in the app for types from NuGet packages. To keep IDs as
named components for existing clients: AddStronglyTypedIds(ids => ids.AsComponents = true).
Trimming- and AOT-compatible. The document is built again on every request, so cache it:
app.MapOpenApi().CacheOutput() (with AddOutputCache() and UseOutputCache()).
Related packages
- Hlibz.MinimalApi.Endpoints:
minimal API endpoints as classes, each class's
<summary>its operation description. The sample is built on it. - Hlibz.Results.AspNetCore: one error body for minimal APIs and controllers.
Full documentation and a sample: github.com/hlib-zinchenko/Hlibz.OpenApi.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. net11.0 is compatible. |
-
net10.0
- Microsoft.AspNetCore.OpenApi (>= 10.0.14)
-
net11.0
- Microsoft.AspNetCore.OpenApi (>= 11.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.0 | 72 | 11/18/2026 |
| 1.0.0-preview.6 | 49 | 11/17/2026 |
| 1.0.0-preview.5 | 63 | 11/14/2026 |
| 1.0.0-preview.4 | 53 | 11/14/2026 |
| 1.0.0-preview.3 | 60 | 11/13/2026 |
| 1.0.0-preview.2 | 58 | 11/13/2026 |
| 1.0.0-preview.1 | 61 | 11/13/2026 |