WilderMinds.SwaggerHierarchySupport 1.0.0

.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 WilderMinds.SwaggerHierarchySupport --version 1.0.0                

                    
                

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

                    
                

            
#r "nuget: WilderMinds.SwaggerHierarchySupport, 1.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. 
// Install WilderMinds.SwaggerHierarchySupport as a Cake Addin
#addin nuget:?package=WilderMinds.SwaggerHierarchySupport&version=1.0.0

// Install WilderMinds.SwaggerHierarchySupport as a Cake Tool
#tool nuget:?package=WilderMinds.SwaggerHierarchySupport&version=1.0.0

SwaggerHierarchySupport

This is a small Nuget package that can be used to add support for hierarchical tags in SwaggerUI. It uses a plugin for SwaggerUI that is located at:

Example Output

Hierarchical Tags

To use the plugin, you need to install the Nuget Package:

> > dotnet add package WilderMinds.SwaggerUIHierarchySupport

Once you've installed the package, you just need to add the support like this:

  app.UseSwaggerUI(opt =>
  {
    opt.AddHierarchySupport();
  });

To create the hierarchy, you'll want to use Tags with a colon (:) or pipe (|) as delimiters as seen here:

app.MapGet("/weatherforecast", () =>
{
  var forecast = Enumerable.Range(1, 5).Select(index =>
      new WeatherForecast
      (
          DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
          Random.Shared.Next(-20, 55),
          summaries[Random.Shared.Next(summaries.Length)]
      ))
      .ToArray();
  return forecast;
})
.WithName("GetWeatherForecast")
.WithTags("Weather:Forcast") // Weather is the top level, and the Forcast is the sub-tag
.WithOpenApi();
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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 31,411 1/28/2024
1.0.1 19,647 4/4/2023
1.0.0 1,222 2/18/2023