oqo0.SwaggerThemes 1.3.1

.NET 6.0 This package targets .NET 6.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 oqo0.SwaggerThemes --version 1.3.1                

                    
                

            
NuGet\Install-Package oqo0.SwaggerThemes -Version 1.3.1
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="oqo0.SwaggerThemes" Version="1.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add oqo0.SwaggerThemes --version 1.3.1                

                    
                

            
#r "nuget: oqo0.SwaggerThemes, 1.3.1"
#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. 
// Install oqo0.SwaggerThemes as a Cake Addin
#addin nuget:?package=oqo0.SwaggerThemes&version=1.3.1

// Install oqo0.SwaggerThemes as a Cake Tool
#tool nuget:?package=oqo0.SwaggerThemes&version=1.3.1

Swagger themes

github issues github last commits

Change Swagger documentation theme easily.

💾 Install

With NuGet CLI:

nuget install oqo0.SwaggerThemes

Using NuGet Package Manager: https://www.nuget.org/packages/oqo0.SwaggerThemes/

📚 Usage

Select any theme from themes list and apply it using following ways:

📖 Using with Swashbuckle
app.UseSwagger();
app.UseSwaggerThemes(Theme.UniversalDark);
app.UseSwaggerUI();

[!IMPORTANT] Don't use UseSwaggerUI() before UseSwaggerThemes() or themes are not going to get installed.

📖 Using with NSwag
app.UseOpenApi();
app.UseSwaggerUi(options =>
{
    options.CustomInlineStyles = SwaggerTheme.GetSwaggerThemeCss(Theme.UniversalDark);
});
🔧 Adding custom CSS
string customCss = "body {" +
                   "    background-color: red;" +
                   "}";

app.UseSwaggerThemes(Theme.UniversalDark, customCss );

🎨 Themes

Dracula

alt text

Theme.Dracula

Gruvbox

alt text

Theme.Gruvbox

Monokai

alt text

Theme.Monokai

Nord Dark

alt text

Theme.NordDark

One Dark

alt text

Theme.OneDark

Universal Dark

alt text

Theme.UniversalDark

X-Code Light

alt text

Theme.XCodeLight

Sepia

alt text

Theme.Sepia

💡 Creating your own themes

  1. Create theme .css in Themes directory.
  2. Add a placeholder for filename in Theme.cs:
public static Theme YourTheme => new("your-theme.css");
  1. Add an embedded resource for your .css file:
    ...
    <EmbeddedResource Include="Themes\your-theme.css" />
</ItemGroup>
  1. Use any other complete theme as a template.
  2. Build project:
dotnet build -c Release
  1. Package .nupkg file is going to appear in ./bin/Release
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on oqo0.SwaggerThemes:

Repository Stars
BehzadDara/URLShortener
Version Downloads Last updated
1.3.3 15,832 6/28/2024
1.3.2 2,930 5/31/2024
1.3.1 3,204 3/13/2024
1.3.0 2,314 1/24/2024
1.2.2 200 1/9/2024
1.2.1 431 12/19/2023
1.2.0 185 10/14/2023
1.1.0 137 10/14/2023