How to customise the name of property?

I have a WebApi controller action that takes a string authToken parameter, which it reads from the Auth-Token header. swagger-ui code-gens this as authToken which means requests via swagger-ui don’t write the header correctly.

How can I customise the name of this parameter so that swagger-ui does the right thing?

[domaindrivendev]

The exact implementation for this depends on how you’ve implemented the header-to-parameter binding in WebApi. I did it by creating two custom classes - FromHeaderAttribute (derived from ParameterBindingAttribute) and HeaderParameterBinding (derived from HttpParameteBinding). I can share the details if needed but the net result gave me a re-usable attribute (similar to FromUri and FromBody) for binding string parameters to header values. For example …

public int Create([FromHeader(Name = "Auth-Token")]string authToken, Customer customer)

Then, to describe these parameters correctly in the resulting Swagger, I implemented and wired up a custom IOperationFilter (see readme) that updates the descriptions accordingly:

// HandleFromHeaderParams.cs
public class HandleFromHeaderParams : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        var fromHeaderParams = apiDescription.ActionDescriptor.GetParameters()
            .Where(param => param.GetCustomAttributes<FromHeaderAttribute>().Any())
            .ToArray();

        foreach (var param in fromHeaderParams)
        {
            var fromHeaderAttribute = param.GetCustomAttributes<FromHeaderAttribute>().First();
            var operationParam = operation.parameters.First(p => p.name == param.ParameterName);

            operationParam.name = fromHeaderAttribute.Name;
            operationParam.@in = "header";
        }
    }
}

// SwaggerConfig.cs
c.OperationFilter<HandleFromHeaderParams>();

This worked first go … the swagger description and hence swagger-ui described the parameters correctly and the correct headers get sent when a request is made through the UI.

Try it out and let me know how it goes

Richie

[DwarfPorter]

It’s very helpful for Swashbuckle version 4, however, in version 5.0.0-rc4 the interface is changed to interface IOperationFilter { void Apply(OpenApiOperation operation, OperationFilterContext context);

and not clearly how to make the parameters