Microsoft.AspNetCore.OpenApi
9.0.0-rc.2.24474.3
Prefix Reserved
dotnet add package Microsoft.AspNetCore.OpenApi --version 9.0.0-rc.2.24474.3
NuGet\Install-Package Microsoft.AspNetCore.OpenApi -Version 9.0.0-rc.2.24474.3
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0-rc.2.24474.3" />
paket add Microsoft.AspNetCore.OpenApi --version 9.0.0-rc.2.24474.3
#r "nuget: Microsoft.AspNetCore.OpenApi, 9.0.0-rc.2.24474.3"
// Install Microsoft.AspNetCore.OpenApi as a Cake Addin #addin nuget:?package=Microsoft.AspNetCore.OpenApi&version=9.0.0-rc.2.24474.3&prerelease // Install Microsoft.AspNetCore.OpenApi as a Cake Tool #tool nuget:?package=Microsoft.AspNetCore.OpenApi&version=9.0.0-rc.2.24474.3&prerelease
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
- Microsoft.OpenApi (>= 1.6.17)
NuGet packages (307)
Showing the top 5 NuGet packages that depend on Microsoft.AspNetCore.OpenApi:
Package | Downloads |
---|---|
Rystem.Api.Server
Rystem.Api helps you to integrate Api Server and Automated Client for Aspect-Oriented programming. |
|
Indice.AspNetCore
Package Description |
|
GreatUtilities.Web
Essencial tools to agile development. |
|
RevolutionaryStuff.AspNetCore
Package Description |
|
Fsel.Core
Fsel Core Package |
GitHub repositories (122)
Showing the top 5 popular GitHub repositories that depend on Microsoft.AspNetCore.OpenApi:
Repository | Stars |
---|---|
jasontaylordev/CleanArchitecture
Clean Architecture Solution Template for ASP.NET Core
|
|
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
|
|
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 9 RC2, 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.
|
|
RicoSuter/NSwag
The Swagger/OpenAPI toolchain for .NET, ASP.NET Core and TypeScript.
|
|
dotnet/eShop
A reference .NET application implementing an eCommerce site
|
Version | Downloads | Last updated |
---|---|---|
9.0.0-rc.2.24474.3 | 19,836 | 10/8/2024 |
9.0.0-rc.1.24452.1 | 19,304 | 9/10/2024 |
9.0.0-preview.7.24406.2 | 9,812 | 8/13/2024 |
9.0.0-preview.6.24328.4 | 7,715 | 7/9/2024 |
9.0.0-preview.5.24306.11 | 9,446 | 6/11/2024 |
9.0.0-preview.4.24267.6 | 3,719 | 5/21/2024 |
9.0.0-preview.3.24172.13 | 10,195 | 4/11/2024 |
9.0.0-preview.2.24128.4 | 4,826 | 3/12/2024 |
9.0.0-preview.1.24081.5 | 2,378 | 2/13/2024 |
8.0.10 | 674,063 | 10/8/2024 |
8.0.8 | 1,898,378 | 8/13/2024 |
8.0.7 | 1,766,474 | 7/9/2024 |
8.0.6 | 2,662,653 | 5/28/2024 |
8.0.5 | 899,245 | 5/14/2024 |
8.0.4 | 1,958,664 | 4/9/2024 |
8.0.3 | 2,131,369 | 3/12/2024 |
8.0.2 | 1,995,904 | 2/13/2024 |
8.0.1 | 2,285,613 | 1/9/2024 |
8.0.0 | 4,104,996 | 11/14/2023 |
8.0.0-rc.2.23480.2 | 92,845 | 10/10/2023 |
8.0.0-rc.1.23421.29 | 46,436 | 9/12/2023 |
8.0.0-preview.7.23375.9 | 54,445 | 8/8/2023 |
8.0.0-preview.6.23329.11 | 37,174 | 7/11/2023 |
8.0.0-preview.5.23302.2 | 14,744 | 6/13/2023 |
8.0.0-preview.4.23260.4 | 87,899 | 5/16/2023 |
8.0.0-preview.3.23177.8 | 12,944 | 4/11/2023 |
8.0.0-preview.2.23153.2 | 7,748 | 3/14/2023 |
8.0.0-preview.1.23112.2 | 4,951 | 2/21/2023 |
7.0.20 | 116,300 | 5/28/2024 |
7.0.19 | 60,091 | 5/14/2024 |
7.0.18 | 116,000 | 4/9/2024 |
7.0.17 | 120,136 | 3/12/2024 |
7.0.16 | 185,375 | 2/13/2024 |
7.0.15 | 288,311 | 1/9/2024 |
7.0.14 | 609,885 | 11/14/2023 |
7.0.13 | 1,127,094 | 10/24/2023 |
7.0.12 | 828,275 | 10/10/2023 |
7.0.11 | 1,301,727 | 9/12/2023 |
7.0.10 | 1,724,589 | 8/8/2023 |
7.0.9 | 1,490,158 | 7/11/2023 |
7.0.8 | 676,370 | 6/22/2023 |
7.0.7 | 948,078 | 6/13/2023 |
7.0.5 | 3,122,986 | 4/11/2023 |
7.0.4 | 1,335,781 | 3/14/2023 |
7.0.3 | 1,569,738 | 2/14/2023 |
7.0.2 | 1,429,178 | 1/10/2023 |
7.0.1 | 923,480 | 12/13/2022 |
7.0.0 | 1,523,940 | 11/7/2022 |
7.0.0-rc.2.22476.2 | 26,012 | 10/11/2022 |
7.0.0-rc.1.22427.2 | 23,329 | 9/14/2022 |
7.0.0-preview.7.22376.6 | 10,488 | 8/9/2022 |
7.0.0-preview.6.22330.3 | 7,635 | 7/12/2022 |
7.0.0-preview.5.22303.8 | 8,962 | 6/14/2022 |
7.0.0-preview.4.22251.1 | 6,738 | 5/10/2022 |