Swagger enum with names

Question

Is it possilbe in Swashbuckle.AspNetCore.Swagger (6.1.1) to get such enum with names? I need better names for generate API client for frontend app.

public enum BasketResourceEnum
{
    Stocks = 1,
    Currencies
}

Now I get such representation in json, I need name instead of int values

  "BasketResourceEnum": {
    "enum": [
      1,
      2
    ],
    "type": "integer",
    "format": "int32"
  },

Maybe that could help you: https://stackoverflow.com/questions/36452468/swagger-ui-web-api-documentation-present-enums-as-strings — TheTanic, Mar 31 '21 at 08:10

score 4 · Accepted Answer · answered Jul 23 '21 at 22:40

4

services
    .AddControllers()
    .AddJsonOptions(options => 
        options.SerializerSettings.Converters.Add(new StringEnumConverter()));

answered Jul 23 '21 at 22:40

user3119533

186
1
7

How to do that only for specific enums? (I don't want to mess with existing api calls, I only want new enums that are added to the project to be serialized and deserialized as strings) – Thanasis Ioannidis Apr 03 '23 at 11:40
@ThanasisIoannidis - You could either opt-in to string conversion by placing a `[JsonConverter(typeof(StringEnumConverter))]` attribute on your new enums or override StringEnumConverter's CanConvert method to specify the types you want to convert as strings. – user3119533 Apr 03 '23 at 21:18

score 3 · Answer 2 · answered Jan 25 '23 at 10:54

If you prefer to use System.Text.Json:

using System.Text.Json.Serialization;
...
var builder = WebApplication.CreateBuilder(args);
builder.Services
    .AddControllers()
    .AddJsonOptions(options => options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));

score 2 · Answer 3 · answered Apr 17 '23 at 07:11

And if you prefer not to choose to serialize enum values as strings but just have the names of their members described in Swagger, you can you the this nuget.

In a minimal API you can:

using Unchase.Swashbuckle.AspNetCore.Extensions.Extensions;
...
builder.Services.ConfigureSwaggerGen(options =>
{
    options.AddEnumsWithValuesFixFilters();
});

Swagger enum with names

3 Answers3