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

NuGet | Sample