APIWeaver.OpenApi 2.3.0

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package APIWeaver.OpenApi --version 2.3.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="APIWeaver.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 APIWeaver.OpenApi --version 2.3.0
                    


                    

                
#r "nuget: APIWeaver.OpenApi, 2.3.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 APIWeaver.OpenApi@2.3.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=APIWeaver.OpenApi&version=2.3.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=APIWeaver.OpenApi&version=2.3.0
                    


                            Install as a Cake Tool

APIWeaver

Pipeline Coverage NuGet Version NuGet Downloads

APIWeaver is a powerful and lightweight library that integrates Swagger UI and OpenAPI support into your .NET 9 applications. It is designed to be user-friendly, fully configurable, and AOT compatible. Built on top of Microsoft's built-in OpenAPI document generation, the library offers a range of extension methods and transformers to enhance OpenAPI documents and operations.

Features

  • Fully functional and configurable Swagger UI
  • Dark mode support 🌙
  • Native AOT compatibility
  • Useful extension methods & transformers for OpenAPI documents and operations
  • High test coverage ensures reliability

🚀 Getting Started

  1. Install the package
dotnet add package APIWeaver
  1. Add the necessary using directive
using APIWeaver;
  1. Configure your application

Add the following to your Program.cs:

builder.Services.AddOpenApiDocument();

if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
    app.MapSwaggerUi();
}

That's it! 🎉 Your app now has a fully functional, AOT-compatible Swagger UI. Open /swagger in your browser to check it out. For more examples and advanced configuration, check out the documentation.

🛠️ Roadmap

  • More useful transformers for OpenAPI documents and operations
  • Support for additional OpenAPI UIs

💬 Feedback & Suggestions

Your feedback is invaluable in making APIWeaver even better! If you have ideas for new features, improvements, or other thoughts, please feel free to share them.

🤝 Contributing

Contributions are welcome! Feel free to open issues or pull requests.

License

This project is licensed under the MIT License. See LICENSE for more information. This means APIWeaver will always remain free.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on APIWeaver.OpenApi:

Package Downloads
APIWeaver

APIWeaver is a powerful and lightweight library that integrates Swagger UI and OpenAPI support into your .NET 9 applications.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on APIWeaver.OpenApi:

Repository Stars
foxminchan/BookWorm
The practical implementation of .NET Aspire using Microservices
Version Downloads Last Updated
2.7.0 21,778 11/13/2024
2.6.2 687 10/29/2024
2.6.1 90 10/29/2024
2.6.0 119 10/28/2024
2.5.0 836 10/26/2024
2.5.0-preview.3 145 9/23/2024
2.5.0-preview.2 73 9/22/2024
2.5.0-preview.1 68 9/22/2024
2.4.2 778 10/9/2024
2.4.1 3,849 9/13/2024
2.4.0 99 9/6/2024
2.3.0 138 9/3/2024
2.2.0 96 8/28/2024
2.1.0 106 8/27/2024
2.0.0 102 8/26/2024
2.0.0-preview.3 86 8/25/2024
2.0.0-preview.2 93 8/25/2024
1.1.1 182 3/4/2024
1.1.0 173 2/21/2024
1.0.0 189 2/15/2024
0.0.1-alpha.10 94 2/14/2024
0.0.1-alpha.9 81 2/12/2024
0.0.1-alpha.8 71 2/12/2024
0.0.1-alpha.7 81 2/11/2024
0.0.1-alpha.6 75 2/11/2024
0.0.1-alpha.5 80 2/11/2024
0.0.1-alpha.4 76 2/10/2024
0.0.1-alpha.3 82 2/9/2024
0.0.1-alpha.2 84 2/9/2024