Neptunee.Swagger 1.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package Neptunee.Swagger --version 1.0.1
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Neptunee.Swagger" />
                    


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


                    

                
#r "nuget: Neptunee.Swagger, 1.0.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. 
#:package Neptunee.Swagger@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Neptunee.Swagger&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Neptunee.Swagger&version=1.0.1
                    


                            Install as a Cake Tool

Neptunee.Swagger

alternate text is missing from this package README image

alternate text is missing from this package README image

Generate Swagger with additional useful info

alternate text is missing from this package README image

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();

<div style="display: flex;justify-content: center;">

NuGet | Sample

</div>

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.  net9.0 was computed.  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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 330 11/9/2023
1.0.0 415 10/20/2023