Swagger-UI refuses to add request header

[jaman1020]

I've been pulling my hair out on this, not sure if I'm doing something wrong?
I have been unable to get a swagger-ui request to include ANY type of header. My Grape API uses an API token in the header for auth, and no matter what I do I cannot get it to show up in anything. I've tried all of the api-key example code, so I must be doing SOMETHING wrong.

However, upon closer inspection, even the demo petstore app does not contain an api header in the request headers.

I'm using the readme/sample code verbatim right now -

function addApiKeyAuthorization(){
        var key = encodeURIComponent($('#input_apiKey')[0].value);
        if(key && key.trim() != "") {
            var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
            window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
            log("added key " + key);
        }
      }

How can I get a request header of "api_key: value" to show up in request headers?

[webron]

That's probably because of a known bug. Can you try the develop_2.0 branch?

[jaman1020]

Just tried it and the same thing happened.
Here is the relevant code in index.html -

      function addApiKeyAuthorization(){
        var key = encodeURIComponent($('#input_apiKey')[0].value);
        if(key && key.trim() != "") {
            var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
            window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
            log("added key " + key);
        }
      }

      $('#input_apiKey').change(addApiKeyAuthorization);

      // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...

        var apiKey = "myApiKeyXXXX123456789";
        $('#input_apiKey').val(apiKey);
        addApiKeyAuthorization();

and the request headers -

I've also tried changing apiKeyAuth to 'header' instead of query, no dice

[ponelat]

Yes, a legacy line has been causing some hair-loss.
We've removed a dead line that caused confusion...
#1205
Try after removing that line(s), and if it's still not working - I'll try and replicate.

[jaman1020]

That fixed the initial crash I was having, but unfortunately still didn't add a header. I'm inspecting the request both on the chrome side and grape side and there's nothing in either

[ponelat]

Ok, I'm going to replicate. You're using the readme example, from develop_2.0?

[ponelat]

The key in the example is a "query" key, meaning it gets attached to url?api_key=some-key.
It looks like it's working on develop_2.0
Try changing "

var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
// to this...
var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "header"); // <- make it a header key

[ponelat]

We currently support "query" and "header" auth keys, although there is a mechanism to manipulate each request before it gets executed, meaning you can have access to all headers, parameters, etc. Which is a little more "hands on" though.
You should see the request header, if you change the above - I'm testing it with Google Chromes' Network tab.

[jaman1020]

Not sure what I'm doing wrong, but I still can't see it. I downloaded the develop_2.0 branch and opened ./dist/index.html in chrome. I haven't changed anything but this line in the whole project. This is the entire contents of the script tag -

  <script type="text/javascript">
    $(function () {
      var url = window.location.search.match(/url=([^&]+)/);
      if (url && url.length > 1) {
        url = decodeURIComponent(url[1]);
      } else {
        url = "http://petstore.swagger.io/v2/swagger.json";
      }
      window.swaggerUi = new SwaggerUi({
        url: url,
        dom_id: "swagger-ui-container",
        supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
        onComplete: function(swaggerApi, swaggerUi){
          if(typeof initOAuth == "function") {
            /*
            initOAuth({
              clientId: "your-client-id",
              realm: "your-realms",
              appName: "your-app-name"
            });
            */
          }

          $('pre code').each(function(i, e) {
            hljs.highlightBlock(e)
          });

          addApiKeyAuthorization();
        },
        onFailure: function(data) {
          log("Unable to Load SwaggerUI");
        },
        docExpansion: "none",
        sorter : "alpha"
      });

      function addApiKeyAuthorization(){
        var key = encodeURIComponent($('#input_apiKey')[0].value);
        if(key && key.trim() != "") {
            var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "header");
            window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
            log("added key " + key);
        }
      }

      $('#input_apiKey').change(addApiKeyAuthorization);

      // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...

        var apiKey = "myApiKeyXXXX123456789";
        $('#input_apiKey').val(apiKey);


      window.swaggerUi.load();

      function log() {
        if ('console' in window) {
          console.log.apply(console, arguments);
        }
      }
  });
  </script>

and this is what I see in Chrome's tab when I click explore -

Remote Address:[::1]:9292
Request URL:http://localhost:9292/v1
Request Method:GET
Status Code:401 Unauthorized
Response Headers
view source
Access-Control-Allow-Credentials:true
Access-Control-Allow-Methods:GET, POST, OPTIONS, PUT, DELETE
Access-Control-Allow-Origin:null
Access-Control-Expose-Headers:
Access-Control-Max-Age:1728000
Connection:Keep-Alive
Content-Length:27
Content-Type:application/json
Date:Wed, 06 May 2015 10:59:46 GMT
Server:WEBrick/1.3.1 (Ruby/2.1.2/2014-05-08)
Vary:Origin
Request Headers
view source
accept:application/json;charset=utf-8,*/*
Accept-Encoding:gzip, deflate, sdch
Accept-Language:en-US,en;q=0.8
Cache-Control:no-cache
Connection:keep-alive
Host:localhost:9292
Origin:null
Pragma:no-cache
User-Agent:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.135 Safari/537.36

[ponelat]

Are you trying to use an api_key to access your spec?
...I've been looking at executing operations (eg: GET /pet).

[jaman1020]

I was...I just whitelisted the swagger url and everything loaded...doh
I did, however, get a Uncaught TypeError: Cannot read property 'undefined' of undefined error after it loaded. I think I remember seeing that in another issue? stacktrace if helpful -

Uncaught TypeError: Cannot read property 'undefined' of undefined
9.Operation.resolveModel    @   index.js:248
9.module.exports    @   index.js:131
(anonymous function)    @   spec-converter.js:38
arrayEach   @   binaryIndex.js:28
65.module.exports   @   mergeData.js:45
(anonymous function)    @   spec-converter.js:18
61.module.exports   @   isLaziable.js:13
baseForOwn  @   createFind.js:24
60.module.exports   @   isIndex.js:1
65.module.exports   @   mergeData.js:46
3.SwaggerClient.buildFromSpec   @   spec-converter.js:12
6.Resolver.resolve  @   model.js:135
(anonymous function)    @   resolver.js:218
7.SwaggerSpecConverter.finish   @   operation.js:401
7.SwaggerSpecConverter.resourceListing.http.on.response @   operation.js:275
(anonymous function)    @   spec-converter.js:508
111.Request.callback    @   index.js:24
(anonymous function)    @   index.js:24
112.Emitter.emit    @   index.js:24
111.Request.end.xhr.onreadystatechange  @   index.js:24

[ponelat]

Sorry, I'm back (so is github)
Hmm, undefined of undefined - ain't that a pickle. I'm not familiar with the issue (probably is out there) but this looks like an unguarded variable reference.

Could be an error in the spec, that's causing this ugly error. Which isn't very friendly at all.
If you like I can take a look at the spec, otherwise... try validating it with swagger-tools. To get you going. This is an issue in the error reporting at the very least, but it may be related to the spec.

[webron]

Otherwise, you can share your definition with us and we'll try to find the problem.

[ifig]

Anything new concerning the missing headers?