Bielu.AspNetCore.AsyncApi.OpenApiSchema 3.2.0

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Bielu.AspNetCore.AsyncApi.OpenApiSchema --version 3.2.0
                    
NuGet\Install-Package Bielu.AspNetCore.AsyncApi.OpenApiSchema -Version 3.2.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Bielu.AspNetCore.AsyncApi.OpenApiSchema" Version="3.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Bielu.AspNetCore.AsyncApi.OpenApiSchema" Version="3.2.0" />
                    
Directory.Packages.props
<PackageReference Include="Bielu.AspNetCore.AsyncApi.OpenApiSchema" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Bielu.AspNetCore.AsyncApi.OpenApiSchema --version 3.2.0
                    
#r "nuget: Bielu.AspNetCore.AsyncApi.OpenApiSchema, 3.2.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Bielu.AspNetCore.AsyncApi.OpenApiSchema@3.2.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Bielu.AspNetCore.AsyncApi.OpenApiSchema&version=3.2.0
                    
Install as a Cake Addin
#tool nuget:?package=Bielu.AspNetCore.AsyncApi.OpenApiSchema&version=3.2.0
                    
Install as a Cake Tool

Bielu.AspNetCore.AsyncApi.OpenApiSchema

Describes your AsyncAPI message payloads as OpenAPI 3.0 Schema Objects, declared with schemaFormat: application/vnd.oai.openapi;version=3.0.0, so tools built for OpenAPI read event payloads the way they read HTTP bodies. The OpenAPI schema is converted from the JSON Schema the generator already produces, so it follows your .NET types without a second definition to keep in sync.

Installation

dotnet add package Bielu.AspNetCore.AsyncApi.OpenApiSchema

Usage

builder.Services.AddAsyncApi(options => options
    .AddServer("kafka", "broker:9092", "kafka")
    .AddOpenApiSchemaPayloads(openApi => openApi
        .ForMessages("orderPlaced")));           // optional: only these messages
JSON Schema OpenAPI 3.0
"type": ["null", "string"] "type": "string", "nullable": true
several types anyOf with one type per branch
numeric exclusiveMinimum / exclusiveMaximum the bound with exclusiveMinimum: true / exclusiveMaximum: true
const, examples a one-value enum, example
discriminator property name Discriminator Object
$ref to components/schemas written inline (a recursive one points at an OpenAPI copy, <name>.openapi)

The JSON Schema stays under components/schemas, and headers stay JSON Schema. The output validates against the official AsyncAPI 2.6.0 and 3.1.0 schemas, including their OpenAPI 3.0 Schema Object definition.

Documentation

Feedback & Contributing

Copyright (c) 2025 Arkadiusz Biel. Released under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
3.2.1-beta.20261122143854 0 11/22/2026
3.2.0 0 11/22/2026
3.2.0-beta.20261122094934 0 11/22/2026
3.2.0-beta.20261122094355 0 11/22/2026
3.2.0-beta.20261122092907 0 11/22/2026
3.2.0-beta.20261122092905 0 11/22/2026
3.2.0-beta.20261122083752 0 11/22/2026
3.2.0-beta.20261122014032 0 11/22/2026
3.2.0-beta.20261122013857 0 11/22/2026
3.2.0-beta.20261121211904 7 11/21/2026
3.2.0-beta.20261121204849 15 11/21/2026
3.2.0-beta.20261121204255 25 11/21/2026
3.2.0-beta.20261121204154 19 11/21/2026
3.2.0-beta.20261121203506 19 11/21/2026
3.2.0-beta.20261121202954 27 11/21/2026
3.2.0-beta.20261121193613 29 11/21/2026
3.2.0-beta.20261121193116 30 11/21/2026
3.2.0-beta.20261121112417 42 11/21/2026