How do I tell swashbuckle to add a required header #501

christopheblin · 2015-09-17T08:44:51Z

I have one of my API controller that requires a header to be present (this is not a security header).

From what I've found on the internet (http://stackoverflow.com/questions/26742521/sending-dynamic-custom-headers-in-swagger-ui-try-outs), in java you can use http://docs.swagger.io/swagger-core/apidocs/com/wordnik/swagger/annotations/ApiImplicitParam.html with a paramType="header"

@ApiImplicitParams(
    { @ApiImplicitParam(paramType="header", name="X-CurrentLocale", dataType="string") }
)

How do I do the same in Swashbuckle ?

The text was updated successfully, but these errors were encountered:

bhupinder7 · 2015-09-23T18:43:27Z

HI there, If you are customizing the index.html page then you can add your own header by changing the addApiKeyAuthorization javascript function in the index.html page and by adding below properties in the SwaggerConfig.cs class.

SwaggerConfig.cs

config.EnableSwagger(
c =>
{
c.ApiKey("apiKey")
.Description("API Key Authentication")
.Name("apiKey")
.In("header");
})

function addApiKeyAuthorization() {
var key = encodeURIComponent($('#input_apiKey')[0].value);
if (key && key.trim() != "") {

          key = "Bearer " + key;

          var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("Authorization", key, "header");
          window.swaggerUi.api.clientAuthorizations.add("key", apiKeyAuth);
          log("added key " + key);
      }
  }

domaindrivendev · 2015-09-25T15:36:44Z

In addition, if you'd like to list the header as a parameter with each operation description, you can just wire it up via an IOperationFilter (see readme). Here's some sample code to get you started:

public class AddRequiredHeaderParameter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters == null)
            operation.parameters = new List<Parameter>();

        operation.parameters.Add(new Parameter
            {
                name = "Foo-Header",
                @in = "header",
                type = "string",
                required = true
            });
    }
}

bunny1985 · 2015-10-10T20:12:20Z

it does not close all use cases at all.
For exampel i Want to document Requested with and __CSRFToken headers.
NMote that CSRF token will be necesary only for "POST LIKE" actions - not for "GET"
How could i do it ?

VisualBean · 2016-06-13T12:13:58Z

I know this is sort of old, but I will respond anyway, as I was led here by some google-fu

it does not close all use cases at all.
For exampel i Want to document Requested with and __CSRFToken headers.
NMote that CSRF token will be necesary only for "POST LIKE" actions - not for "GET"
How could i do it ?

If you document your actions with [HttpGet], [HttpPut], [HttpPost] etc.
you can quite easily create an operationsfilter to find all Post actions

var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline().Where( f => f.Scope == FilterScope.Action );
var isPostOperation = filterPipeline.Select(f => f.Instance).OfType<HttpPostAttribute>().FirstOrDefault() !=
                        null;

mrugeshparekh · 2017-07-07T14:11:35Z

My swagger UI is generated automatically.
I am trying to add apikey to each request header. But some reason how its not added to each header.
For example its not added to http://localhost/swagger/ui/index
My config looks like following. (C#)

GlobalConfiguration.Configuration 
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("Version1", "API");

                        // NOTE: You must also configure 'EnableApiKeySupport' below in the SwaggerUI section
                        c.ApiKey("apiKey")
                            .Description("API Key Authentication")
                            .Name("Token")
                            .In("header");
                        
                        c.IncludeXmlComments(GetXmlCommentsPath());
                        
                        c.UseFullTypeNameInSchemaIds();
						
                        c.OperationFilter<AddDefaultHeader>();
						
                        c.ResolveConflictingActions(apiDescriptions => apiDescriptions.FirstOrDefault());                       
                    })
                .EnableSwaggerUi(c =>
                    {
                        c.InjectStylesheet(thisAssembly, "API.Content.SwaggerStyle.css");

                        

                        // If your API supports ApiKey, you can override the default values.
                        // "apiKeyIn" can either be "query" or "header"                                                
                        //
                        c.EnableApiKeySupport("apiKey", "header");
                    });

bkwdesign · 2017-08-04T13:44:51Z

Following upon @VisualBean 's example, I created this special header for my OData V4 patch requests.
FWIW - scaffolded OData controllers don't decorate "Patch" actions with the HttpPatchAttribute, so, I modified this look either for the attribute, or for simply the action name "Patch"

public class AssignReturnRepresentationHeader : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {

        var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline().Where(f => f.Scope == FilterScope.Action);
        var isNamedPatch = apiDescription.ActionDescriptor.ActionName == "Patch";
        var isPatchOperation = filterPipeline.Select(f => f.Instance).OfType<HttpPatchAttribute>().FirstOrDefault() != null || isNamedPatch;
        

        if (!isPatchOperation)
            return;

        if (operation.parameters == null)
            operation.parameters = new List<Parameter>();

        operation.parameters.Add(new Parameter
        {
            name = "Prefer",
            @in = "header",
            type = "string",
            @default = "return=representation",
            description = "For OData V4 this header is needed if you want to return a representation of the changed entity.",
            required = true
        });
    }
}

abhargavasharma · 2018-05-14T01:45:07Z

If you copy and paste below code SwaggerConfig.cs, it will work.

using System.Web.Http;
using WebActivatorEx;
using OAuthTokenBasedRestService;
using Swashbuckle.Application;
using Swashbuckle.Swagger;
using System.Web.Http.Description;
using System.Collections.Generic;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace OAuthTokenBasedRestService
{
	public class SwaggerConfig
	{
		public static void Register()
		{
			var thisAssembly = typeof(SwaggerConfig).Assembly;

			GlobalConfiguration.Configuration
				.EnableSwagger(c =>
					{
						c.SingleApiVersion("v1", "OAuthTokenBasedRestService");
						c.OperationFilter<AddRequiredAuthorizationHeaderParameter>();
					})
				.EnableSwaggerUi(c =>
					{
						c.EnableApiKeySupport("apiKey", "header");
					});

		}
	}

	public class AddRequiredAuthorizationHeaderParameter : IOperationFilter
	{
		public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
		{
			if (operation.parameters == null)
				operation.parameters = new List<Parameter>();

			operation.parameters.Add(new Parameter
			{
				name = "Authorization",
				@in = "header",
				type = "string",
				required = true,
				description = "access token"
			});
		}
	}
	
}

ayeshathecoder · 2018-06-21T09:16:44Z

@abhargavasharma it is not coming on the UI. I have tried all the above solutions.
Can anyone provide the screenshot and any test urls for auth and token.

i7657043 · 2018-08-27T16:07:36Z

@ayeshathecoder

Create a new Class named CustomFilters in the namespaceFooSpace.Filters and add the following code.

using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Collections.Generic;

namespace FooSpace.Filters
{
    public class CustomFilters
    {
        public class AuthHeaderFilter : IOperationFilter
        {
            public void Apply(Operation operation, OperationFilterContext context)
            {
                if (operation.Parameters == null)
                    operation.Parameters = new List<IParameter>();
                

                operation.Parameters.Add(new NonBodyParameter
                {
                    Name = "Authorization",
                    In = "header",
                    Type = "string",
                    Required = false,
                    Default = "Bearer "
                });
            }
        }
    }
}

In Startup.cs, in the ConfigureServices() method add the following lines of code after services.AddMvc();:

services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info { Title = "API", Version = "v1" });
                c.OperationFilter<Filters.CustomFilters.AuthHeaderFilter>();
            });

ayeshathecoder · 2018-08-30T11:12:19Z

Actually I am using oAuth2 with password flow. It will be helpful , if you can provide the example for same. Currently no value is passed in header i.e. username and password. public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuration .EnableSwagger(c => { c.SingleApiVersion("v1", "Misys.OpicsPlus.Framework.Rest.ApplicationService"); c.UseFullTypeNameInSchemaIds(); c.BasicAuth("basic").Description("HTTP Authentication Method"); c.OAuth2("oauth2") .Description("OAuth2 Grant") .Flow("password") .TokenUrl(" https://BLR2TCM29.misys.global.ad/SecureTokenServiceRestV4.0/api/authorization/requestaccesstoken ") .Scopes(scopes => { scopes.Add("acccess", "try out the sample api"); } ); c.OperationFilter<AddRequiredAuthorizationHeaderParameter>(); }) .EnableSwaggerUi(c => { c.EnableOAuth2Support( clientId: "Sample_App", clientSecret: "xxxxx", realm: "test-realm", appName: "Swagger UI"); }); } public class AddRequiredAuthorizationHeaderParameter : IOperationFilter { public void Apply(Swashbuckle.Swagger.Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) { var actFilters = apiDescription.ActionDescriptor.GetFilterPipeline(); var allowsAnonymous = actFilters.Select(f => f.Instance).OfType<OverrideAuthorizationAttribute>().Any(); if (allowsAnonymous) return; // must be an anonymous method //var scopes = apiDescription.ActionDescriptor.GetFilterPipeline() // .Select(filterInfo => filterInfo.Instance) // .OfType<AllowAnonymousAttribute>() // .SelectMany(attr => attr.Roles.Split(',')) // .Distinct(); if (operation.security == null) operation.security = new List<IDictionary<string, IEnumerable<string>>>(); var oAuthRequirements = new Dictionary<string, IEnumerable<string>> { {"oauth2", Enumerable.Empty<string>()} }; operation.security.Add(oAuthRequirements); } } Any help is highly appreciated. Regards, Ayesha

…

On Mon, Aug 27, 2018 at 9:37 PM Jordan Griffiths ***@***.***> wrote: @ayeshathecoder <https://github.com/ayeshathecoder> Create a new Class named CustomFilters in the namespaceFooSpace.Filters and add the following code. using Swashbuckle.AspNetCore.Swagger; using Swashbuckle.AspNetCore.SwaggerGen; using System.Collections.Generic; namespace FooSpace.Filters { public class CustomFilters { public class AuthHeaderFilter : IOperationFilter { public void Apply(Operation operation, OperationFilterContext context) { if (operation.Parameters == null) operation.Parameters = new List<IParameter>(); operation.Parameters.Add(new NonBodyParameter { Name = "Authorization", In = "header", Type = "string", Required = false, Default = "Bearer " }); } } } } In Startup.cs, in the ConfigureServices()method add the following lines of code after services.AddMvc();: services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "API", Version = "v1" }); c.OperationFilter<Filters.CustomFilters.AuthHeaderFilter>(); }); — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#501 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ANF9IHPQzBRIQ4Ma7CSCp2Sysql88oZYks5uVBlQgaJpZM4F--5R> .

Chris-Upshop · 2018-10-10T21:18:32Z

In addition, if you'd like to list the header as a parameter with each operation description, you can just wire it up via an IOperationFilter (see readme). Here's some sample code to get you started:

public class AddRequiredHeaderParameter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters == null)
            operation.parameters = new List<Parameter>();

        operation.parameters.Add(new Parameter
            {
                name = "Foo-Header",
                @in = "header",
                type = "string",
                required = true
            });
    }
}

This works great but is there a way to do this and then exclude it from one or two places?

javafun · 2019-03-05T02:25:38Z

Can anyone suggest me how to add token parameter to get method?

iby-dev · 2019-03-05T16:35:03Z

@cward-ADC is what i used to do add a token parameter.

rohanaceres · 2019-08-14T23:05:58Z

AddDefaultHeader

Can I add a required parameter without generics?
I'm trying to add them dynamically using reflection.

tojoirinah · 2019-12-18T13:11:48Z

In addition, if you'd like to list the header as a parameter with each operation description, you can just wire it up via an IOperationFilter (see readme). Here's some sample code to get you started:
public class AddRequiredHeaderParameter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters == null)
            operation.parameters = new List<Parameter>();

        operation.parameters.Add(new Parameter
            {
                name = "Foo-Header",
                @in = "header",
                type = "string",
                required = true
            });
    }
} 
This works great but is there a way to do this and then exclude it from one or two places?

It works only for post method, how about get ?

celsojr · 2020-04-10T19:50:22Z

In addition, if you'd like to list the header as a parameter with each operation description, you can just wire it up via an IOperationFilter (see readme). Here's some sample code to get you started:
public class AddRequiredHeaderParameter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters == null)
            operation.parameters = new List<Parameter>();

        operation.parameters.Add(new Parameter
            {
                name = "Foo-Header",
                @in = "header",
                type = "string",
                required = true
            });
    }
} 
This works great but is there a way to do this and then exclude it from one or two places?
It works only for post method, how about get ?

[HttpGet]
public IActionResult Get([FromHeader(Name = "Foo-Header")] string mediaType)
{
    // TODO: something
}

Thaval · 2020-09-22T20:45:13Z

I don't know how this works for you guys, but my OperationFilter is applied AFTER the request, which means first my Web API Controller is called and THEN this operation filter runs. Actually I wanted to have swagger add some custom headers to the request. Everyone says IOperationFilter is the answer, but I'm pretty sure it's not.

Thaval · 2020-09-30T11:58:05Z

Got it, know how it is intended to work now.

tonlopes21 · 2021-12-01T21:06:23Z

Também gostaria de saber como funciona, estou com o mesmo problema.

domaindrivendev closed this as completed Sep 25, 2015

domaindrivendev mentioned this issue Jul 13, 2016

adding custom header #755

Closed

MurtuzaTravadi mentioned this issue Feb 16, 2017

Add Extra Parameter in swagger ui like Response Content Type , Key 152365432 , datetime 20/01/2017 15:30:0 #1010

Closed

bkwdesign mentioned this issue Aug 4, 2017

ODataController Updated does not return the same way Created returns in OData V4 OData/WebApi#824

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

How do I tell swashbuckle to add a required header #501

How do I tell swashbuckle to add a required header #501

christopheblin commented Sep 17, 2015

bhupinder7 commented Sep 23, 2015

domaindrivendev commented Sep 25, 2015

bunny1985 commented Oct 10, 2015

VisualBean commented Jun 13, 2016

mrugeshparekh commented Jul 7, 2017 •

edited

Loading

bkwdesign commented Aug 4, 2017

abhargavasharma commented May 14, 2018 •

edited

Loading

ayeshathecoder commented Jun 21, 2018

i7657043 commented Aug 27, 2018

ayeshathecoder commented Aug 30, 2018 via email

Chris-Upshop commented Oct 10, 2018

javafun commented Mar 5, 2019

iby-dev commented Mar 5, 2019

rohanaceres commented Aug 14, 2019

tojoirinah commented Dec 18, 2019

celsojr commented Apr 10, 2020 •

edited

Loading

Thaval commented Sep 22, 2020

Thaval commented Sep 30, 2020

tonlopes21 commented Dec 1, 2021

How do I tell swashbuckle to add a required header #501

How do I tell swashbuckle to add a required header #501

Comments

christopheblin commented Sep 17, 2015

bhupinder7 commented Sep 23, 2015

domaindrivendev commented Sep 25, 2015

bunny1985 commented Oct 10, 2015

VisualBean commented Jun 13, 2016

mrugeshparekh commented Jul 7, 2017 • edited Loading

bkwdesign commented Aug 4, 2017

abhargavasharma commented May 14, 2018 • edited Loading

ayeshathecoder commented Jun 21, 2018

i7657043 commented Aug 27, 2018

ayeshathecoder commented Aug 30, 2018 via email

Chris-Upshop commented Oct 10, 2018

javafun commented Mar 5, 2019

iby-dev commented Mar 5, 2019

rohanaceres commented Aug 14, 2019

tojoirinah commented Dec 18, 2019

celsojr commented Apr 10, 2020 • edited Loading

Thaval commented Sep 22, 2020

Thaval commented Sep 30, 2020

tonlopes21 commented Dec 1, 2021

mrugeshparekh commented Jul 7, 2017 •

edited

Loading

abhargavasharma commented May 14, 2018 •

edited

Loading

celsojr commented Apr 10, 2020 •

edited

Loading