AspNetCore.SwaggerUI.Themes

Introduction

Swashbuckle.AspNetCore is a popular library for adding Swagger support to ASP.NET Core projects, making it easier to document and interact with your APIs.

AspNetCore.SwaggerUI.Themes builds upon Swashbuckle.AspNetCore.SwaggerUI, enhancing the Swagger UI with modern and visually appealing themes.

Features

• New Themes: enhances the Swagger documentation interface with different themes, including a default style that retains the classic Swagger UI appearance and new modern styles.
• Seamless Integration: simply install the package and add the style parameter to the existing method used for SwaggerUI.

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 or ModernStyle 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 class.