Swagger renders endpoint parameter in path with a wrong type

[lommez]

Is there an existing issue for this?

• I have searched the existing issues

Description

In my application, it has an endpoint just like the code below:

    HttpGet("get-by-origin/{origin}")]
    public IActionResult GetByOrigin(Origin origin)
    {
        return Ok();
    }

Here is the enum, an enum converter and where it is add to the JsonOptions:

    public enum Origin
    {
        Inside = 1,
        Outside = 2
    }
    
    public class OriginConverter : JsonConverter<Origin>
    {
        public override Origin Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            if (reader.TokenType != JsonTokenType.String)
            {
                throw new JsonException();
            }

            if (Enum.TryParse(reader.GetString(), ignoreCase: true, out Origin enumValue))
            {
                return enumValue;
            }
            else
            {
                throw new JsonException();
            }
        }

        public override void Write(Utf8JsonWriter writer, Origin value, JsonSerializerOptions options)
        {
            writer.WriteStringValue(value.ToString());
        }
    }
    
    // That method is called when the services are configured 
    private void ConfigureJsonOptions(ServiceConfigurationContext context)
    {
        context
            .Services
            .AddOptions<JsonOptions>()
            .Configure<IServiceProvider>((options, serviceProvider) =>
            {
                options.JsonSerializerOptions.Converters.Add(new OriginConverter());
            });
    }

And in this image, is where the Swagger is configured:

But the endpoint parameter on the path is configured as int32 instead of string. And even the select is filled with a value, it is considered as an invalid form.

I´ve tried to do it in complete new application without using abp and works perfectly.
It looks like that converters added to the JSON options has no effect.
Is something that I´m missing or this is a bug?

Reproduction Steps

No response

Expected behavior

No response

Actual behavior

No response

Regression?

No response

Known Workarounds

No response

Version

7.4.4

User Interface

Angular

Database Provider

EF Core (Default)

Tiered or separate authentication server

Separate Auth Server

Operation System

Windows (Default)

Other information

No response

[maliming]

hi

Please share a minimal project. Thanks.

[lommez]

Hi, @maliming
i´ve provided a sample application to show that Swagger is not working as expected.
At least in this demo the type on the endpoint path is in correct type, as string.
But Swagger form didn´t recognize that field is filled.

Here is the url to my project

https://github.com/lommez/abp-swagger

[maliming]

hi

context.Services.AddAbpSwaggerGenWithOAuth(
            configuration["AuthServer:Authority"]!,
            new Dictionary<string, string>
            {
                    {"AbpSwagger", "AbpSwagger API"}
            },
            options =>
            {
                options.SwaggerDoc("v1", new OpenApiInfo { Title = "AbpSwagger API", Version = "v1" });
                options.DocInclusionPredicate((docName, description) => true);
                options.CustomSchemaIds(type => type.FullName);
                options.SchemaFilter<MyAbpSwashbuckleEnumSchemaFilter>();
                options.HideAbpEndpoints();
            });

public class MyAbpSwashbuckleEnumSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (context.Type.IsEnum)
        {
            schema.Enum.Clear();
            schema.Type = "string";
            schema.Format = null;
            Enum.GetNames(context.Type)
                .ToList()
                .ForEach(name => schema.Enum.Add(new OpenApiString($"{name}")));
        }
    }
}

[lommez]

Thanks @maliming !
It works perfectly!