APIWeaver.MsBuild 2.5.0-preview.3

This is a prerelease version of APIWeaver.MsBuild.

dotnet add package APIWeaver.MsBuild --version 2.5.0-preview.3

NuGet\Install-Package APIWeaver.MsBuild -Version 2.5.0-preview.3

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.MsBuild" Version="2.5.0-preview.3">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

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

<PackageVersion Include="APIWeaver.MsBuild" Version="2.5.0-preview.3" />
                    

                            Directory.Packages.props

<PackageReference Include="APIWeaver.MsBuild">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    

                            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.MsBuild --version 2.5.0-preview.3

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

#r "nuget: APIWeaver.MsBuild, 2.5.0-preview.3"

#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.MsBuild@2.5.0-preview.3

#: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.MsBuild&version=2.5.0-preview.3&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=APIWeaver.MsBuild&version=2.5.0-preview.3&prerelease
                    

                            Install as a Cake Tool

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

APIWeaver

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

Install the package

dotnet add package APIWeaver

Add the necessary using directive

using APIWeaver;

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

Minimal, native AOT friendly generator for API Clients (WIP)
More useful transformers for OpenAPI documents and operations

💬 Feedback & Suggestions

Your feedback is important to make 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	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. 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.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
2.5.0-preview.3	85	9/23/2024
2.5.0-preview.2	107	9/22/2024
2.5.0-preview.1	74	9/22/2024