Neptunee.Swagger 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 Neptunee.Swagger --version 1.0.0                

                    
                

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

                    
                

            
#r "nuget: Neptunee.Swagger, 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 Neptunee.Swagger as a Cake Addin
#addin nuget:?package=Neptunee.Swagger&version=1.0.0

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

Neptunee.Swagger

Generate Swagger with additional useful info

Get Starting

  • Install the NuGet package:
dotnet add package Neptunee.Swagger
  • ApiGroup Enum
public enum SampleApiGruop
{
    [NeptuneeDocInfoGenerator(title: "All APIs")]
    All,

    [NeptuneeDocInfoGenerator(title: "Module1 APIs", version: "v1")]
    Module1,

    [NeptuneeDocInfoGenerator(version: "Module2 APIs")]
    Module2,

    [NeptuneeDocInfoGenerator(title: "Dashboard APIs")]
    Dashboard,

    [NeptuneeDocInfoGenerator(title: "MobileApp APIs")]
    MobileApp,
}
  • DI registration:
builder.Services.AddNeptuneeSwagger(o =>
    o.SwaggerDocs<SampleApiGruop>()
        .GroupNamesDocInclusion(escapeDocs: SampleApiGruop.All.ToString())
        .AddJwtBearerSecurityScheme());
  • Use Middleware:
app.UseNeptuneeSwagger(o => o.AddEndpoints<SampleApiGruop>());

Using

  • How do Group APIs ?
    [NeptuneeApiGroup<ApiGroupNames>(ApiGroupNames.Dashboard)]
    public IActionResult Api() => Ok();
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 is compatible.  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.1 293 11/9/2023
1.0.0 387 10/20/2023