SwaggerUI.OpenApi 2.0.0

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package SwaggerUI.OpenApi --version 2.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SwaggerUI.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 SwaggerUI.OpenApi --version 2.0.0
                    


                    

                
#r "nuget: SwaggerUI.OpenApi, 2.0.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. 
#addin nuget:?package=SwaggerUI.OpenApi&version=2.0.0
                    


                            Install SwaggerUI.OpenApi as a Cake Addin
                        

                    

                
#tool nuget:?package=SwaggerUI.OpenApi&version=2.0.0
                    


                            Install SwaggerUI.OpenApi as a Cake Tool

SwaggerUI.OpenApi

Build Status SwaggerUI.OpenApi

A package to simplify adding Swagger UI to .NET 9's Microsoft.AspNetCore.OpenApi.

Usage

  1. In your Program.cs file Add app.AddSwaggerUI() and app.MapSwaggerUI():

      builder.Services.AddOpenApi();
+ builder.Services.AddSwaggerUI();

  var app = builder.Build();

  app.MapOpenApi();
+ app.MapSwaggerUI();

  2. (Optional) Modify your launchSettings.json file to open Swagger automatically:

    -  "launchBrowser": false,
+  "launchBrowser": true,
  "applicationUrl": "http://localhost:5150",
+  "launchUrl": "swagger",

Features

Authentication

If you want to add authentication to your Swagger you can use the following helper methods:

builder.Services.AddOpenApi("v1", o =>
{
    o.AddOAuth2(authorizationUrl, tokenUrl, scopes);
});

builder.Services.AddSwaggerUI("v1", o =>
{
    o.AddOAuth2(clientId, scopes);
});

There are other helper methods for Duende Identity Server AddIdentityServer() and Auth0 AddAuth0.

You can check the samples directory for complete working examples.

More snippet

Adds PowerShell and CMD cURL to the request snippet by default Request snippet

Styles

Easily change syntax highlighting style

builder.Services.AddSwaggerUI(o =>
{
    o.SyntaxHighlight = new SyntaxHighlightOptions
    {
        Theme = SyntaxHighlightThemeType.Arta
    };
});

Agate Arta Obsidian

Parameter validation

Displays the common validations in the parameters form by default

app.MapGet("/products",
    ([Range(0, 10000)] int id,
    [MinLength(3)][MaxLength(50)] string name,
    [RegularExpression("\\d\\d-\\d\\d")] string code) => id)

Validation

Authorization persistence

Persists authorization data by default and it would not be lost on browser close or refresh so you don't have to authenticate everytime.

Roadmap

✅ Basic UI

✅ Authentication

✅ Enable all the documents

✅ Implement all Swagger UI options

⏳ Improve test coverage

Acknowledgement

This project is based on Swashbuckle.AspNetCore.SwaggerUI. Thanks for their awesome work.

Pre-release builds

Get the package from here.

Build

Install the required .NET SDK and run:

$ dotnet build
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. 
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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 43 2 days ago
1.2.0 175 17 days ago
1.1.0 127 a month ago
1.0.0 494 5 months ago
0.6.0 180 6 months ago
0.5.0 193 6/12/2024
0.4.0 97 6/9/2024
0.3.0 91 5/29/2024
0.2.0 88 5/25/2024
0.1.0 99 5/15/2024