Bielu API Descriptions

Tools for describing, generating, and validating API specifications for ASP.NET Core — spanning both request/response APIs and event-driven, workflow-based ones.

Supported .NET versions and EOL policy covers the current support matrix, planned framework additions, and when targets are removed from the package family.

AsyncAPI

Bielu.AspNetCore.AsyncApi generates AsyncAPI documents from minimal or controller-based APIs — the same developer experience as Microsoft.AspNetCore.OpenApi, for event-driven channels and messages.

  • Runtime and build-time document generation
  • Document and schema transformers
  • Protocol bindings — AMQP, HTTP, MQTT, Kafka, WebSockets, Pulsar, SNS, SQS, SignalR, gRPC, SSE, WebRTC
  • Interactive UI via Scalar
  • CLI validation/diff and Roslyn analyzers

Get started with AsyncAPI →  ·  API reference →

Arazzo

Bielu.Arazzo.NET is the object model, writers, validation, and reader for the Arazzo Specification — describing multi-step API workflows that can span both OpenAPI and AsyncAPI sources.

  • ArazzoDocument model, JSON/YAML writers, structural validation
  • Runtime-expression parser/evaluator for the full spec §5.9 grammar
  • JSON and YAML readers with diagnostics (Bielu.Arazzo.NET.Readers)
  • ArazzoWorkspace — the seam for resolving workflow steps against live OpenAPI/AsyncAPI documents

Get started with Arazzo →  ·  API reference →

Overlay

Bielu.Overlay.NET implements the Overlay Specification — declarative, repeatable transformations of an API description, so reshaping a generated document is a reviewable artifact instead of imperative code.

  • OverlayDocument model, structural validation, and apply engine
  • Overlay 1.0.0 and 1.1.0, with version-gated semantics
  • Works on a JsonNode tree, so OpenAPI, AsyncAPI, and Arazzo descriptions are all valid targets
  • JSON and YAML readers with diagnostics (Bielu.Overlay.NET.Readers)
  • dotnet overlay CLI for applying and validating overlays

Get started with Overlay →  ·  API reference →

⚠️ Note: Before version 1.0.0, these libraries are regarded as unstable and breaking changes may be introduced.

Edit this page