From 5f2298220077a7345626e493d001d609af4a39a9 Mon Sep 17 00:00:00 2001 From: Samuel Reed Date: Wed, 9 Jul 2014 11:45:44 -0500 Subject: [PATCH] Allow easy setting of accessToken in explorer UI. --- index.js | 6 ++-- public/css/loopbackStyles.css | 21 +++++++++++ public/index.html | 10 +++--- public/lib/loadSwaggerUI.js | 67 +++++++++++++++++++++++------------ 4 files changed, 75 insertions(+), 29 deletions(-) create mode 100644 public/css/loopbackStyles.css diff --git a/index.js b/index.js index 7c517f7..69d8f57 100644 --- a/index.js +++ b/index.js @@ -1,4 +1,4 @@ -'use strict'; + 'use strict'; /*! * Adds dynamically-updated docs as /explorer */ @@ -23,7 +23,7 @@ module.exports = explorer; function explorer(loopbackApplication, options) { options = _defaults({}, options, { - basePath: loopbackApplication.get('restApiRoot') || '/', + basePath: loopbackApplication.get('restApiRoot') || '', name: 'swagger', resourcePath: 'resources', apiInfo: loopbackApplication.get('apiInfo') || {} @@ -37,7 +37,7 @@ function explorer(loopbackApplication, options) { app.get('/config.json', function(req, res) { res.send({ - url: path.join(options.basePath, options.name, options.resourcePath) + url: path.join(options.basePath || '/', options.name, options.resourcePath) }); }); // Allow specifying a static file root for swagger files. Any files in that folder diff --git a/public/css/loopbackStyles.css b/public/css/loopbackStyles.css new file mode 100644 index 0000000..44bb7df --- /dev/null +++ b/public/css/loopbackStyles.css @@ -0,0 +1,21 @@ +/* Styles used for loopback explorer customizations */ +.accessTokenDisplay { + color: white; + margin-right: 10px; +} +.accessTokenDisplay.set { + border-bottom: 1px dotted #333; position: relative; cursor: pointer; +} +.accessTokenDisplay.set:hover:after { + content: attr(data-tooltip); + position: absolute; + white-space: nowrap; + background: rgba(0, 0, 0, 0.85); + padding: 3px 7px; + color: #FFF; + border-radius: 3px; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; + right: 0; + bottom: -30px; +} diff --git a/public/index.html b/public/index.html index 6960bcd..d0f1175 100644 --- a/public/index.html +++ b/public/index.html @@ -7,6 +7,7 @@ + @@ -31,10 +32,11 @@
- - -
- +
+ Access Token Not Set + +
+
diff --git a/public/lib/loadSwaggerUI.js b/public/lib/loadSwaggerUI.js index 7bdd805..b6135a3 100644 --- a/public/lib/loadSwaggerUI.js +++ b/public/lib/loadSwaggerUI.js @@ -1,42 +1,65 @@ 'use strict'; // Refactoring of inline script from index.html. -/*global SwaggerUi, log, ApiKeyAuthorization, hljs */ +/*global SwaggerUi, log, ApiKeyAuthorization, hljs, window, $ */ $(function() { - $.getJSON('config.json', function(config) { - log(config); - loadSwaggerUi(config); - }); -}); + $.getJSON('config.json', function(config) { + log(config); + loadSwaggerUi(config); + }); -function loadSwaggerUi(config) { + var accessToken; + function loadSwaggerUi(config) { window.swaggerUi = new SwaggerUi({ - url: config.url || "/swagger/resources", - apiKey: "", - dom_id: "swagger-ui-container", + url: config.url || '/swagger/resources', + apiKey: '', + dom_id: 'swagger-ui-container', supportHeaderParams: true, supportedSubmitMethods: ['get', 'post', 'put', 'delete'], onComplete: function(swaggerApi, swaggerUi) { - log("Loaded SwaggerUI"); + log('Loaded SwaggerUI'); log(swaggerApi); log(swaggerUi); $('pre code').each(function(i, e) {hljs.highlightBlock(e); }); }, onFailure: function(data) { - log("Unable to Load SwaggerUI"); + log('Unable to Load SwaggerUI'); log(data); }, - docExpansion: "none" + docExpansion: 'none' }); - $('#input_accessToken').change(function() { - var key = $('#input_accessToken')[0].value; - log("key: " + key); - if(key && key.trim() !== "") { - log("added accessToken " + key); - window.authorizations.add("key", new ApiKeyAuthorization("accessToken", key, "query")); - } - }); + $('#explore').click(setAccessToken); + $('#api_selector').submit(setAccessToken); + $('#input_accessToken').keyup(onInputChange); window.swaggerUi.load(); -} + } + + function setAccessToken(e) { + e.stopPropagation(); // Don't let the default #explore handler fire + e.preventDefault(); + var key = $('#input_accessToken')[0].value; + log('key: ' + key); + if(key && key.trim() !== '') { + log('added accessToken ' + key); + window.authorizations.add('key', new ApiKeyAuthorization('accessToken', key, 'query')); + accessToken = key; + $('.accessTokenDisplay').text('Access Token Set.').addClass('set'); + $('.accessTokenDisplay').attr('data-tooltip', 'Current Token: ' + key); + } + } + + function onInputChange(e) { + var el = e.currentTarget; + var key = $(e.currentTarget)[0].value; + if (!key || key.trim === '') return; + if (accessToken !== key) { + $('.accessTokenDisplay').text('Access Token changed; submit to confirm.'); + } else { + $('.accessTokenDisplay').text('Access Token Set.'); + } + } +}); + +