Jtechs.OpenApi.AspNetCore.Swashbuckle 0.2.1

OpenApi.AspNetCore

This package helps openapi swagger.json to have detailed enum information.

Jtechs.OpenApi.AspNetCore

https://www.nuget.org/packages/Jtechs.OpenApi.AspNetCore

Base common file for the openapi helper. Add enum to have title and description to the swagger.json

Jtechs.OpenApi.AspNetCore.Swashbuclke

https://www.nuget.org/packages/Jtechs.OpenApi.AspNetCore.Swashbuckle

Swashbuclke extension to add enum title and description in the $type section.

if you define following enum in C#

[DisplayNameForEnum("MLB League"), Description("MLB League names")]
public enum League
{
    [DisplayNameForEnum("American League"), Description("The American League of Professional Baseball Clubs, known simply as the American League (AL), is one of two leagues that make up Major League Baseball (MLB) in the United States and Canada.")]
    American = 1,

    [DisplayNameForEnum("National League"), Description("The National League of Professional Baseball Clubs, known simply as the National League (NL), is the older of two leagues constituting Major League Baseball (MLB) in the United States and Canada.")]
    National = 2,
}

You can use this nuget package and write following in your Program.cs

builder.Services.AddSwaggerGen(options =>
{
    options.SchemaFilter<TitleAndDescriptionSchemaFilter>();
    options.SchemaFilter<EnumSchemaFilter>();
    options.UseAllOfToExtendReferenceSchemas();
});

this will add more detail information on swagger.json

"components": {
    "schemas": {
      "League": {
        "title": "MLB League",
        "enum": [
          1,
          2
        ],
        "type": "integer",
        "description": "MLB League names",
        "format": "int32",
        "x-enum-values": [
          1,
          2
        ],
        "x-enum-varnames": [
          "American",
          "National"
        ],
        "x-enum-titles": [
          "American League",
          "National League"
        ],
        "x-enum-descriptions": [
          "The American League of Professional Baseball Clubs, known simply as the American League (AL), is one of two leagues that make up Major League Baseball (MLB) in the United States and Canada.",
          "The National League of Professional Baseball Clubs, known simply as the National League (NL), is the older of two leagues constituting Major League Baseball (MLB) in the United States and Canada."
        ]
      },
    }
}

License

Apache License Version 2.0

See LICENSE

Support

If you would like to support our Open Source Activity, you can do it from our Sponsor Page

Copyright (c) 2024- J-Tech Japan