Bielu.AspNetCore.ApiDescriptions 2.0.0

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Bielu.AspNetCore.ApiDescriptions --version 2.0.0

NuGet\Install-Package Bielu.AspNetCore.ApiDescriptions -Version 2.0.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.ApiDescriptions" Version="2.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Bielu.AspNetCore.ApiDescriptions" Version="2.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Bielu.AspNetCore.ApiDescriptions" />
                    

                            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.ApiDescriptions --version 2.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Bielu.AspNetCore.ApiDescriptions, 2.0.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.ApiDescriptions@2.0.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.ApiDescriptions&version=2.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Bielu.AspNetCore.ApiDescriptions&version=2.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Bielu.AspNetCore.ApiDescriptions

Shared build-time document generation for the Bielu API-description packages.

dotnet getdocument (run by Microsoft.Extensions.ApiDescription.Server during dotnet build) asks a single IDocumentProvider for every document an app serves. This package owns that provider: it writes Microsoft.AspNetCore.OpenApi's documents and those of every registered IBuildTimeDocumentSource (AsyncAPI, Arazzo, ...), and settles their file names so two documents never land in the same file.

Packages that describe a new document family register a source:

services.AddBuildTimeDocumentSource<MyBuildTimeDocumentSource>();

This is an implementation detail of Bielu.AspNetCore.AsyncApi and Bielu.AspNetCore.Arazzo, published because they depend on it.

Documentation

Full documentation

Feedback & Contributing

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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- No dependencies.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Bielu.AspNetCore.ApiDescriptions:

Package	Downloads
Bielu.AspNetCore.AsyncApi Code-first AsyncAPI document generation for ASP.NET Core. Describe channels, operations and messages with attributes or a fluent API, then serve the generated AsyncAPI 2.6 or 3.1 document from your app with MapAsyncApi() — or write it at build time. Supports XML doc comments, message examples, protocol bindings (SignalR, gRPC, SSE, WebRTC), multiple documents and Native AOT.	36.7K
Bielu.AspNetCore.ApiCatalog Serves an RFC 9727 API catalog at /.well-known/api-catalog: a Linkset listing every API description the app serves (AsyncAPI, OpenAPI, Arazzo), discovered from the app's own endpoints, so clients can find the documents without knowing their URLs.	2.2K
Bielu.AspNetCore.XRegistry Serves the messages and payload schemas of an app's AsyncAPI documents as a read-only CNCF xRegistry (1.0-rc4): a message definitions registry and a schema registry, with the standard HTTP API, so registry-aware tooling can discover them.	1.9K
Bielu.AspNetCore.ApiDescriptions.Mcp Experimental. Exposes an app's own API descriptions (AsyncAPI, OpenAPI and Arazzo documents) to AI agents through a Model Context Protocol server: the documents as resources, plus read-only tools to list them and look up AsyncAPI operations and message schemas.	862

GitHub repositories

This package is not used by any popular GitHub repositories.