adding services.json endpoint

Author: jkyberneees

demos/basic.js

@@ -9,7 +9,12 @@ gateway({
 
   routes: [{
     prefix: '/public',
-    target: 'http://public.myapp:300'
+    target: 'http://public.myapp:300',
+    docs: {
+      name: 'Public Service',
+      endpoint: 'swagger.json',
+      type: 'swagger'
+    }
   }, {
     prefix: '/admin',
     target: 'http://admin.myapp:3000',

index.js

@@ -18,6 +18,16 @@ const gateway = (opts) => {
     server.use(middleware)
   })
 
+  // registering services.json
+  const services = opts.routes.map(route => ({
+    prefix: route.prefix,
+    docs: route.docs
+  }))
+  server.get('/services.json', (req, res) => {
+    res.send(services)
+  })
+
+  // processing routes
   opts.routes.forEach(route => {
     if (undefined === route.prefixRewrite) {
       route.prefixRewrite = ''

test/config.js

@@ -23,7 +23,12 @@ module.exports = async () => {
       }
     }, {
       prefix: '/users',
-      target: 'http://localhost:3000'
+      target: 'http://localhost:3000',
+      docs: {
+        name: 'Users Service',
+        endpoint: 'swagger.json',
+        type: 'swagger'
+      }
     }, {
       prefix: '/users/proxy-aborted',
       target: 'http://localhost:5000',

test/smoke.test.js

@@ -47,6 +47,22 @@ describe('API Gateway', () => {
     await remote.start(3000)
   })
 
+  it('services.json contains registered services', async () => {
+    await request(gateway)
+      .get('/services.json')
+      .expect(200)
+      .then((response) => {
+        expect(response.body.find(service => service.prefix === '/users')).to.deep.equal({
+          prefix: '/users',
+          docs: {
+            name: 'Users Service',
+            endpoint: 'swagger.json',
+            type: 'swagger'
+          }
+        })
+      })
+  })
+
   it('remote is proxied /users/response-time/204 - 204', async () => {
     await request(gateway)
       .post('/users/response-time/204')