Microsoft.AspNetCore.OpenApi 10.0.0-preview.2.25164.1

Prefix Reserved
.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.AspNetCore.OpenApi. 
dotnet add package Microsoft.AspNetCore.OpenApi --version 10.0.0-preview.2.25164.1
                    


                    

                
NuGet\Install-Package Microsoft.AspNetCore.OpenApi -Version 10.0.0-preview.2.25164.1
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="Microsoft.AspNetCore.OpenApi" Version="10.0.0-preview.2.25164.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="10.0.0-preview.2.25164.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.AspNetCore.OpenApi" />
                    


                            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 Microsoft.AspNetCore.OpenApi --version 10.0.0-preview.2.25164.1
                    


                    

                
#r "nuget: Microsoft.AspNetCore.OpenApi, 10.0.0-preview.2.25164.1"
#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. 
#addin nuget:?package=Microsoft.AspNetCore.OpenApi&version=10.0.0-preview.2.25164.1&prerelease
                    


                            Install Microsoft.AspNetCore.OpenApi as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.AspNetCore.OpenApi&version=10.0.0-preview.2.25164.1&prerelease
                    


                            Install Microsoft.AspNetCore.OpenApi as a Cake Tool

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 Compatible and additional computed target framework versions.
.NET net10.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (441)

Showing the top 5 NuGet packages that depend on Microsoft.AspNetCore.OpenApi:

Package Downloads
Rystem.Api

Rystem.Api helps you to integrate Api Server and Automated Client for Aspect-Oriented programming.
Indice.AspNetCore

Package Description
devprime.stack.web

DevPrime Web
IntelliTect.Coalesce

Core framework library for IntelliTect.Coalesce
IntelliTect.Coalesce.CodeGeneration

Core code generation library for IntelliTect.Coalesce

GitHub repositories (179)

Showing the top 5 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
jasontaylordev/CleanArchitecture
Clean Architecture Solution Template for ASP.NET Core
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
JustArchiNET/ArchiSteamFarm
C# application with primary purpose of farming Steam cards from multiple accounts simultaneously.
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 10 Preview 2, 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.
Version Downloads Last updated
10.0.0-preview.2.25164.1 1,611 3/18/2025
10.0.0-preview.1.25120.3 3,898 2/25/2025
9.0.3 354,740 3/11/2025
9.0.2 967,901 2/11/2025
9.0.1 927,685 1/14/2025
9.0.0 2,544,494 11/12/2024
9.0.0-rc.2.24474.3 67,074 10/8/2024
9.0.0-rc.1.24452.1 30,924 9/10/2024
9.0.0-preview.7.24406.2 12,676 8/13/2024
9.0.0-preview.6.24328.4 9,265 7/9/2024
9.0.0-preview.5.24306.11 11,229 6/11/2024
9.0.0-preview.4.24267.6 6,752 5/21/2024
9.0.0-preview.3.24172.13 10,474 4/11/2024
9.0.0-preview.2.24128.4 5,930 3/12/2024
9.0.0-preview.1.24081.5 4,750 2/13/2024
8.0.14 125,229 3/11/2025
8.0.13 323,405 2/11/2025
8.0.12 507,743 1/14/2025
8.0.11 1,530,935 11/12/2024
8.0.10 2,949,380 10/8/2024
8.0.8 3,442,999 8/13/2024
8.0.7 2,610,087 7/9/2024
8.0.6 3,520,880 5/28/2024
8.0.5 1,262,930 5/14/2024
8.0.4 2,861,709 4/9/2024
8.0.3 2,735,371 3/12/2024
8.0.2 2,495,034 2/13/2024
8.0.1 2,941,378 1/9/2024
8.0.0 4,992,519 11/14/2023
8.0.0-rc.2.23480.2 100,938 10/10/2023
8.0.0-rc.1.23421.29 50,405 9/12/2023
8.0.0-preview.7.23375.9 62,293 8/8/2023
8.0.0-preview.6.23329.11 39,697 7/11/2023
8.0.0-preview.5.23302.2 17,548 6/13/2023
8.0.0-preview.4.23260.4 113,093 5/16/2023
8.0.0-preview.3.23177.8 16,011 4/11/2023
8.0.0-preview.2.23153.2 8,317 3/14/2023
8.0.0-preview.1.23112.2 5,701 2/21/2023
7.0.20 267,164 5/28/2024
7.0.19 100,806 5/14/2024
7.0.18 166,731 4/9/2024
7.0.17 149,009 3/12/2024
7.0.16 225,057 2/13/2024
7.0.15 344,650 1/9/2024
7.0.14 753,919 11/14/2023
7.0.13 1,257,329 10/24/2023
7.0.12 984,318 10/10/2023
7.0.11 1,442,719 9/12/2023
7.0.10 1,945,046 8/8/2023
7.0.9 1,686,404 7/11/2023
7.0.8 726,586 6/22/2023
7.0.7 1,088,786 6/13/2023
7.0.5 3,407,255 4/11/2023
7.0.4 1,511,446 3/14/2023
7.0.3 1,759,228 2/14/2023
7.0.2 1,544,716 1/10/2023
7.0.1 1,055,104 12/13/2022
7.0.0 1,800,819 11/7/2022
7.0.0-rc.2.22476.2 28,747 10/11/2022
7.0.0-rc.1.22427.2 25,139 9/14/2022
7.0.0-preview.7.22376.6 11,113 8/9/2022
7.0.0-preview.6.22330.3 8,512 7/12/2022
7.0.0-preview.5.22303.8 10,040 6/14/2022
7.0.0-preview.4.22251.1 7,516 5/10/2022