donalfenwick / swashbucklebasicauthcredentialspopup

Adds a CSS dialog box to swagger-ui to accept username/password input when a user clicks the parameter input for an Authorization header within the api doc

Swashbuckle Basic HTTP Authentication credentials popup

Javascript plugin that can be loaded into swagger-ui when using Swashbuckle to generate api documentation for webapi. The plugin provides an interface for editing basic http credentials when submitting test requests to basic auth protected api endpoints from within swagger-ui.

build and instalation

Install packages npm install

Build gulp default

Copy /build/authPromptPlugin-min.js out to your webapi project and include it as an embedded resource. See injecting custom content on the swashbucke wiki.

To ensure the script is loaded into swagger-ui add the following code when configuring swashbuckle.

   .EnableSwagger( ... )
   .EnableSwaggerUi(c =>
       {
           c.InjectJavaScript(containingAssembly, "myWebApi.SwaggerExtensions.authPromptPlugin-min.js");
           // ...
       });

The popup is triggered when the user clicks on a parameter input field named "Authorization" <input type="text" name="Authorization" />.

The Authorization parameter field is not added to a request in swashbuckle by defualt. In order to wire this up, register the following operation filter during configuration of swashbuckle.

 public class ApplyBasicAuthToApiEndpoints : IOperationFilter
   {
       public string Name { get; private set; }

       public ApplyBasicAuthToApiEndpoints()
       {
           Name = "basic";
       }

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

           // modify the logic in this if statement to apply the header to any api actions that use basic authentication
           // this example uses a custom attribute on the controler actions
           if (apiDescription.ActionDescriptor.GetCustomAttributes<RequireBasicAuthAttribute>(true).Count > 0)
           {
               operation.parameters.Add(new Parameter
               {
                   name = "Authorization",
                   @in = "header",
                   description = "Basic http auth credeitials",
                   required = true,
                   type = "string"
               });
           }

       }
   }