Version History

The table below provides a quick overview of AspNetCore.SwaggerUI.Themes versions and their compatibility with different .NET versions.

• ✔️ Supported: The library version is compatible with the respective .NET version.
• ❌ Unsupported: The library version is not compatible with the respective .NET version.

Getting Started

To use AspNetCore.SwaggerUI.Themes in your ASP.NET Core project, follow these steps:

1. Install the package using .NET CLI or NuGet Package Manager:

   dotnet add package AspNetCore.SwaggerUI.Themes
   

   or

   Install-Package AspNetCore.SwaggerUI.Themes
   

2. In your Program.cs file, add the style through the Style class as new parameter of app.UseSwaggerUI() method:

   using AspNetCore.SwaggerUI.Themes;
   
   ...
   
   app.UseSwaggerUI(Style.Dark);
   

   This code enables the chosen theme for Swagger UI in your application.

   Please be aware that for projects utilizing the older style template with separate Startup.cs and Program.cs files, the previously code should be configured within the Configure method of the Startup class.

Example

Here's an example of how to integrate AspNetCore.SwaggerUI.Themes in your ASP.NET Core application:

using AspNetCore.SwaggerUI.Themes;
...

// Add services to the container. Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

...

// Use Swagger middleware
app.UseSwagger();

// Enable the dark theme for Swagger UI
app.UseSwaggerUI(Style.Dark, c =>
{
    // Your Swagger UI configuration here (optional)
});

...

That's it! Your Swagger UI will now have a sleek dark theme.

Please note that using the InjectStylesheet() method in the Swagger UI configuration will override the provided style.

Contributing

If you have any suggestions, bug reports, or contributions, feel free to open an issue or submit a pull request