ASP.NET Web Api Swagger string parameters error - no description

Question

I am using Swagger UI to test my ASP.NET Web Api app. I added a class to allow operation parameters

public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
    if (operation.Parameters == null) 
        operation.Parameters = new List<OpenApiParameter>();

    operation.Parameters.Add(new OpenApiParameter
    {
        Name = "ApiKey",
        In = ParameterLocation.Header,
        Required = true,
        Schema = new OpenApiSchema
        {
            Type = "String"
        }
    });
    operation.Parameters.Add(new OpenApiParameter
    {
        Name = "Authentication",
        In = ParameterLocation.Header,
        Required = false,
        Schema = new OpenApiSchema
        {
            Type = "String"
        }
    });
}

In my Startup.cs, I added this line to the ConfigurationServices method

c.OperationFilter<CustomHeaderSwaggerAttribute>();

When I try and test one of the controller methods, my ApiKey string parameter always show an error no matter what I put in the textbox.

This probably isn't the answer but would be quick to test. Have you tried: `Type = "string"` with a lowercase S? — SBFrancies, Jan 12 '21 at 15:14
@SBFrancies create and answer for me to mark. Changing "String" to "string" worked! — Ryan, Jan 12 '21 at 17:06

score 1 · Answer 1 · answered Jan 12 '21 at 15:23

I am not sure about the Schema property but the following worked for me in past (setting the type to string):

operation.Parameters.Add(new Parameter
        {
            name = "ApiKey",
            @in = ParameterLocation.Header,
            required = true,
            type = "string"                
        });

For more details, refer to this post

ASP.NET Web Api Swagger string parameters error - no description

1 Answers1