Microsoft.AspNetCore.OpenApi
9.0.10
Prefix Reserved
See the version list below for details.
dotnet add package Microsoft.AspNetCore.OpenApi --version 9.0.10
NuGet\Install-Package Microsoft.AspNetCore.OpenApi -Version 9.0.10
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
<PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
<PackageReference Include="Microsoft.AspNetCore.OpenApi" />
paket add Microsoft.AspNetCore.OpenApi --version 9.0.10
#r "nuget: Microsoft.AspNetCore.OpenApi, 9.0.10"
#:package Microsoft.AspNetCore.OpenApi@9.0.10
#addin nuget:?package=Microsoft.AspNetCore.OpenApi&version=9.0.10
#tool nuget:?package=Microsoft.AspNetCore.OpenApi&version=9.0.10
About
Microsoft.AspNetCore.OpenApi is a NuGet package that provides built-in support for generating OpenAPI documents from minimal or controller-based APIs in ASP.NET Core.
Key Features
- Supports viewing generated OpenAPI documents at runtime via a parameterized endpoint (
/openapi/{documentName}.json) - Supports generating an OpenAPI document at build-time
- Supports customizing the generated document via document transformers
How to Use
To start using Microsoft.AspNetCore.OpenApi in your ASP.NET Core application, follow these steps:
Installation
dotnet add package Microsoft.AspNetCore.OpenApi
Configuration
In your Program.cs file, register the services provided by this package in the DI container and map the provided OpenAPI document endpoint in the application.
var builder = WebApplication.CreateBuilder();
// Registers the required services
builder.Services.AddOpenApi();
var app = builder.Build();
// Adds the /openapi/{documentName}.json endpoint to the application
app.MapOpenApi();
app.Run();
For more information on configuring and using Microsoft.AspNetCore.OpenApi, refer to the official documentation.
Main Types
The main types provided by this library are:
OpenApiOptions: Options for configuring OpenAPI document generation.IDocumentTransformer: Transformer that modifies the OpenAPI document generated by the library.
Feedback & Contributing
Microsoft.AspNetCore.OpenApi is released as open-source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. 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. |
-
net9.0
- Microsoft.OpenApi (>= 1.6.17)
GitHub repositories (274)
Showing the top 20 popular GitHub repositories that depend on Microsoft.AspNetCore.OpenApi:
| Repository | Stars |
|---|---|
|
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
|
|
|
JustArchiNET/ArchiSteamFarm
C# application with primary purpose of farming Steam cards from multiple accounts simultaneously.
|
|
|
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
|
|
|
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 10, 9, 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.
|
|
|
dotnet/eShop
A reference .NET application implementing an eCommerce site
|
|
|
RicoSuter/NSwag
The Swagger/OpenAPI toolchain for .NET, ASP.NET Core and TypeScript.
|
|
|
AssetRipper/AssetRipper
GUI Application to work with engine assets, asset bundles, and serialized files
|
|
|
fullstackhero/dotnet-starter-kit
Production Grade Cloud-Ready .NET 10 Starter Kit (Web API + Blazor Client) with Multitenancy Support, and Clean/Modular Architecture that saves roughly 200+ Development Hours! All Batteries Included.
|
|
|
ChilliCream/graphql-platform
Welcome to the home of the Hot Chocolate GraphQL server for .NET, the Strawberry Shake GraphQL client for .NET and Nitro the awesome Monaco based GraphQL IDE.
|
|
|
dotnet/aspire
Aspire is the tool for code-first, extensible, observable dev and deploy.
|
|
|
ServiceStack/ServiceStack
Thoughtfully architected, obscenely fast, thoroughly enjoyable web services for all
|
|
|
microsoft/fluentui-blazor
Microsoft Fluent UI Blazor components library. For use with ASP.NET Core Blazor applications
|
|
|
thomhurst/TUnit
A modern, fast and flexible .NET testing framework
|
|
|
oskardudycz/EventSourcing.NetCore
Examples and Tutorials of Event Sourcing in .NET
|
|
|
dotnet/maui-samples
Samples for .NET Multi-Platform App UI (.NET MAUI)
|
|
|
SciSharp/LLamaSharp
A C#/.NET library to run LLM (🦙LLaMA/LLaVA) on your local device efficiently.
|
|
|
martinothamar/Mediator
A high performance implementation of Mediator pattern in .NET using source generators.
|
|
|
evolutionary-architecture/evolutionary-architecture-by-example
Navigate the complex landscape of .NET software architecture with our step-by-step, story-like guide. Unpack the interplay between modular monoliths, microservices, domain-driven design, and various architectural patterns. Go beyond the one-size-fits-all solutions and understand how to blend these approaches based on your unique needs.
|
|
|
dotnet/aspnet-api-versioning
Provides a set of libraries which add service API versioning to ASP.NET Web API, OData with ASP.NET Web API, and ASP.NET Core.
|
|
|
davidfowl/TodoApp
Todo application with ASP.NET Core Blazor WASM, Minimal APIs and Authentication
|
| Version | Downloads | Last Updated |
|---|---|---|
| 10.0.0-rc.2.25466.103 | 0 | 9/22/2025 |
| 10.0.0-rc.1.25451.107 | 0 | 9/22/2025 |
| 10.0.0-rc.1.25421.113 | 0 | 9/12/2025 |
| 10.0.0-preview.7.25380.108 | 0 | 8/11/2025 |
| 10.0.0-preview.7.25380.105 | 0 | 8/6/2025 |
| 10.0.0-preview.6.25358.103 | 0 | 7/17/2025 |
| 10.0.0-preview.6.25321.102 | 0 | 6/25/2025 |
| 10.0.0-preview.5.25280.105 | 0 | 6/2/2025 |
| 10.0.0-preview.5.25277.114 | 0 | 6/3/2025 |
| 10.0.0-preview.5.25277.101 | 0 | 5/29/2025 |
| 10.0.0-preview.4.25255.103 | 0 | 5/12/2025 |
| 9.0.10 | 1 | 9/25/2025 |
| 9.0.7 | 1 | 7/11/2025 |