Merge pull request #8 from jkyberneees/add-services-json

Add services json

Author: jkyberneees

README.md

@@ -55,6 +55,12 @@ service.start(3000)
     pathRegex: '/*',
     // route prefix
     prefix: '/public',
+    // Optional documentation configuration (unrestricted schema)
+    docs: {
+      name: 'Public Service',
+      endpoint: '/api-docs',
+      type: 'swagger'
+    },
     // Optional "prefix rewrite" before request is forwarded. Default value: ''
     prefixRewrite: '',
     // Remote HTTP server URL to forward the request
@@ -104,6 +110,26 @@ const onResponse = async (req, res, stream) => {
   }
 }
 ```
+## The "*GET /services.json*" endpoint
+Since version `1.3.5` the gateway exposes minimal documentation about  registered services at: `GET /services.json`
+
+Example output:
+```json
+[  
+   {  
+      "prefix":"/public",
+      "docs":{  
+         "name":"Public Service",
+         "endpoint":"/swagger.json",
+         "type":"swagger"
+      }
+   },
+   {  
+      "prefix":"/admin"
+   }
+]
+```
+> NOTE: Please see `docs` configuration entry explained above.
 
 ## Gateway level caching
 Caching support is provided by the `http-cache-middleware` module. https://www.npmjs.com/package/http-cache-middleware

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 = ''

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-gateway",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "A Node.js API Gateway for the masses!",
   "main": "index.js",
   "scripts": {
@@ -28,15 +28,15 @@
   "dependencies": {
     "fast-proxy": "^1.1.2",
     "http-cache-middleware": "^1.2.3",
-    "restana": "^3.3.0",
+    "restana": "^3.3.1",
     "stream-to-array": "^2.3.0"
   },
   "devDependencies": {
     "chai": "^4.2.0",
     "cors": "^2.8.5",
     "express-jwt": "^5.3.1",
-    "helmet": "^3.18.0",
-    "mocha": "^6.1.4",
+    "helmet": "^3.20.0",
+    "mocha": "^6.2.0",
     "nyc": "^14.1.1",
     "response-time": "^2.3.2",
     "standard": "^12.0.1",

package.json

@@ -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/config.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')