How to add a custom header for every request in Swagger-UI version 3.0

Question

I want to support multiple json versions on my swagger-ui version 3.0. The second json at every ajax call I want to add a custom header with name x-api-version and value 2

I tried this one:

$.ajaxSetup({
    beforeSend: function(xhr) {
        xhr.setRequestHeader('x-my-custom-header', 'some value');
    }
});

But it is not working. The documentation of swagger ui 3.0.0 is poor and I can't find a solution

Answer 1

After some experimenting if appears that Swagger uses jquery for OPTIONS requests whilst it uses superagent client-side HTTP request library for other types of requests such as GET, POST etc...

Thus, to add a custom header for every request in Swagger-UI, use the following code:

    $(document).ready(function () {

    // Intercept jquery ajax request
    $.ajaxSetup({

        beforeSend: function (xhr, settings) {

            // Add the header to the Ajax request
            xhr.setRequestHeader("Authorization", getHeader());
        },

        // Disable caching of AJAX responses
        cache: false

    });

    // Intercept superagent request
    window.swaggerUi.options["requestInterceptor"] = function () {

        // Add the header to the request
        this.headers.Authorization = getHeader();

        return this;
    };

});

function getHeader() {

    var header = ... some code to calculate or generate a header ...

    return header
}