Swagger UI using C# webApi is changing my header parameter to query parameter?

Question

So I decided to use this method since it's the simplest to add custom headers for my api calls, example:

[HttpPost]
[Route("something")]
public async Task<somethingObject> DoSomething([Microsoft.AspNetCore.Mvc.FromHeader(Name = "deviceGuid")] string deviceGuid)
{
    var somethingObject= await doSomethingWithDevice(deviceGuid)
    return somethingObject;
}

The expected outcome from this is a field in Swagger where I can input the deviceGuid and Swagger should consider it as a header.

Issue at hand is that Swagger is considering it a query and not a header:

Any clue how I can solve this?

VisualBean · Accepted Answer · 2018-08-28 11:35:38Z

1

I dont think SwashBuckle (im guessing this is the swagger implementation you're using), knows about FromHeader.
What you could do, is this;
Make an OperationFilter that changes the ParameterType to Header - something like the following; - note I found this in this gist.

public class FromHeaderAttributeOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        foreach (var httpParameterDescriptor in apiDescription.ActionDescriptor.GetParameters().Where(e => e.GetCustomAttributes<FromHeaderAttribute>().Any()))
        {
            var parameter = operation.parameters.Single(p => p.name == httpParameterDescriptor.ParameterName);
            parameter.name = httpParameterDescriptor.GetCustomAttributes<FromHeaderAttribute>().Single().HeaderName;
            parameter.@in = "header";
        }
    }
}

answered Aug 28, 2018 at 11:35

VisualBean

5,0082 gold badges32 silver badges61 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Ali_Nass Over a year ago

I ended up using if (apiDescription.RelativePath.Contains("/registration")) { add custom headers }

VisualBean Over a year ago

You can do that aswell - works perfect when you only got the one route to fix :)

Ali_Nass Over a year ago

Yeah I had 2-3 routes so I ended up using 3 ifs to check the routes, more of a quick nice fix than a permanent one though!

Collectives™ on Stack Overflow

Swagger UI using C# webApi is changing my header parameter to query parameter?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related