chore(rest-explorer): remove redirect from /explorer/ to /explorer

loopbackio · Feb 8, 2019 · 0eeae5b · 0eeae5b
1 parent 56126a0
commit 0eeae5b
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 18 deletions.
diff --git a/packages/rest-explorer/src/__tests__/acceptance/rest-explorer.acceptance.ts b/packages/rest-explorer/src/__tests__/acceptance/rest-explorer.acceptance.ts
@@ -36,11 +36,12 @@ describe('API Explorer (acceptance)', () => {
         .expect(/<title>LoopBack API Explorer/);
     });
 
-    it('redirects from "/explorer" to "/explorer/"', async () => {
+    it('exposes API Explorer at "/explorer"', async () => {
       await request
         .get('/explorer')
-        .expect(301)
-        .expect('location', '/explorer/');
+        .expect(200)
+        .expect('content-type', /html/)
+        .expect(/<title>LoopBack API Explorer/);
     });
 
     it('configures swagger-ui with OpenAPI spec url "/openapi.json', async () => {
@@ -92,8 +93,7 @@ describe('API Explorer (acceptance)', () => {
 
       await request
         .get('/openapi/ui')
-        .expect(301)
-        .expect('Location', '/openapi/ui/');
+        .expect(200, /<title>LoopBack API Explorer/);
 
       await request.get('/explorer').expect(404);
     });

diff --git a/packages/rest-explorer/src/rest-explorer.component.ts b/packages/rest-explorer/src/rest-explorer.component.ts
@@ -24,8 +24,7 @@ export class RestExplorerComponent implements Component {
   ) {
     const explorerPath = config.path || '/explorer';
 
-    this.registerControllerRoute('get', explorerPath, 'indexRedirect');
-    this.registerControllerRoute('get', explorerPath + '/', 'index');
+    this.registerControllerRoute('get', explorerPath, 'index');
 
     application.static(explorerPath, swaggerUI.getAbsoluteFSPath());
 

diff --git a/packages/rest-explorer/src/rest-explorer.controller.ts b/packages/rest-explorer/src/rest-explorer.controller.ts
@@ -5,40 +5,43 @@
 
 import {inject} from '@loopback/context';
 import {
-  RestBindings,
-  RestServerConfig,
   OpenApiSpecForm,
   Request,
   Response,
+  RestBindings,
+  RestServerConfig,
 } from '@loopback/rest';
 import * as ejs from 'ejs';
 import * as fs from 'fs';
 import * as path from 'path';
+import {RestExplorerBindings} from './rest-explorer.keys';
+import {RestExplorerConfig} from './rest-explorer.types';
 
 // TODO(bajtos) Allow users to customize the template
 const indexHtml = path.resolve(__dirname, '../templates/index.html.ejs');
 const template = fs.readFileSync(indexHtml, 'utf-8');
 const templateFn = ejs.compile(template);
 
 export class ExplorerController {
+  private explorerPath: string;
   private openApiSpecUrl: string;
 
   constructor(
     @inject(RestBindings.CONFIG, {optional: true})
     restConfig: RestServerConfig = {},
+    @inject(RestExplorerBindings.CONFIG, {optional: true})
+    config: RestExplorerConfig = {},
     @inject(RestBindings.Http.REQUEST) private request: Request,
     @inject(RestBindings.Http.RESPONSE) private response: Response,
   ) {
     this.openApiSpecUrl = this.getOpenApiSpecUrl(restConfig);
-  }
-
-  indexRedirect() {
-    this.response.redirect(301, this.request.url + '/');
+    this.explorerPath = config.path || '/explorer';
   }
 
   index() {
     const data = {
       openApiSpecUrl: this.openApiSpecUrl,
+      explorerPath: this.explorerPath,
     };
 
     const homePage = templateFn(data);

diff --git a/packages/rest-explorer/templates/index.html.ejs b/packages/rest-explorer/templates/index.html.ejs
@@ -5,9 +5,9 @@
 <head>
   <meta charset="UTF-8">
   <title>LoopBack API Explorer</title>
-  <link rel="stylesheet" type="text/css" href="./swagger-ui.css">
-  <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
-  <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  <link rel="stylesheet" type="text/css" href="<%- explorerPath %>/swagger-ui.css">
+  <link rel="icon" type="image/png" href="<%- explorerPath %>/favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="<%- explorerPath %>/favicon-16x16.png" sizes="16x16" />
   <style>
     html {
       box-sizing: border-box;
@@ -31,8 +31,8 @@
 <body>
   <div id="swagger-ui"></div>
 
-  <script src="./swagger-ui-bundle.js"> </script>
-  <script src="./swagger-ui-standalone-preset.js"> </script>
+  <script src="<%- explorerPath %>/swagger-ui-bundle.js"> </script>
+  <script src="<%- explorerPath %>/swagger-ui-standalone-preset.js"> </script>
   <script>
     window.onload = function () {