From ca4878b521c4d5eb4ac749a8fdf3cec78df54dd3 Mon Sep 17 00:00:00 2001 From: Raymond Feng Date: Fri, 15 Sep 2017 10:44:45 -0700 Subject: [PATCH] Refresh swagger on remoteMethodAdded See https://github.com/strongloop/loopback-component-explorer/pull/208 --- index.js | 7 +++++++ test/explorer.test.js | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) diff --git a/index.js b/index.js index 21a8e8f..1d4d138 100644 --- a/index.js +++ b/index.js @@ -116,6 +116,13 @@ function mountSwagger(loopbackApplication, swaggerApp, opts) { swaggerObject = createSwaggerObject(loopbackApplication, opts); }); + // listening to started event for updating the swaggerObject + // when a call to app.models.[modelName].nestRemoting([modelName]) + // to appear that method in the Swagger UI. + loopbackApplication.on('remoteMethodAdded', function() { + swaggerObject = createSwaggerObject(loopbackApplication, opts); + }); + // listening to remoteMethodDisabled event for updating the swaggerObject // when a remote method is disabled to hide that method in the Swagger UI. loopbackApplication.on('remoteMethodDisabled', function() { diff --git a/test/explorer.test.js b/test/explorer.test.js index dba4099..a3e0db4 100644 --- a/test/explorer.test.js +++ b/test/explorer.test.js @@ -359,6 +359,41 @@ describe('explorer', function() { }); }); + it('updates swagger object when a remote method is added', function(done) { + var app = loopback(); + app.set('remoting', { cors: false }); + configureRestApiAndExplorer(app, '/explorer'); + + // Ensure the swagger object was built + request(app) + .get('/explorer/swagger.json') + .expect(200) + .end(function(err, res) { + if (err) return done(err); + + // Check the method that will be disabled + var paths = Object.keys(res.body.paths); + expect(paths).to.contain('/products/findOne'); + + var Product = app.models.Product; + Product.findOne2 = function(cb) { cb(null, 1); }; + Product.remoteMethod('findOne2', {}); + + // Request swagger.json again + request(app) + .get('/explorer/swagger.json') + .expect(200) + .end(function(err, res) { + if (err) return done(err); + + var paths = Object.keys(res.body.paths); + expect(paths).to.contain('/products/findOne2'); + + done(); + }); + }); + }); + function givenLoopBackAppWithExplorer(explorerBase) { return function(done) { var app = this.app = loopback();