Merge pull request #52 from ClickPop/feature/api-details-returned

👽 Add api details to root response

Author: seanmetzgar

helpers/apiDetails.js

@@ -0,0 +1,26 @@
+const pjson = require('../package.json');
+const apiDetails = {
+  name: pjson.name,
+  version: pjson.version,
+};
+const rootResponse = {
+  data: 'Welcome to the Backtalk API',
+};
+
+if (pjson.author) {
+  apiDetails.author = pjson.author;
+}
+if (pjson.contributors) {
+  apiDetails.contributors = pjson.contributors;
+}
+if (pjson.homepage) {
+  apiDetails.homepage = pjson.homepage;
+}
+
+rootResponse.api = apiDetails;
+
+module.exports = {
+  apiDetails: apiDetails,
+  rootResponse: rootResponse,
+  default: apiDetails,
+};

package-lock.json

@@ -6,6 +6,7 @@ const morgan = require('morgan');
 const cookieParser = require('cookie-parser');
 const restrictAccess = require('../middleware/restrictAccess');
 const cors = require('cors');
+const { rootResponse } = require('../helpers/apiDetails');
 
 app.use(cookieParser(process.env.COOKIE_SECRET));
 app.use(express.json());
@@ -27,7 +28,7 @@ if (process.env.NODE_ENV !== 'production') {
 
 // Default Route
 app.get('/', (req, res) => {
-  return res.json({ data: 'Welcome to this survey app!' });
+  return res.json(rootResponse);
 });
 
 // API (v1) Routes Loader

server/app.js

@@ -13,7 +13,7 @@ describe('Initial Endpoint', () => {
   it('should respond at api root', async (done) => {
     const res = await req.get('/').set('User-Agent', uaString);
     expect(res.status).toBe(200);
-    expect(res.body.data).toBe('Welcome to this survey app!');
+    expect(res.body.data).toBe('Welcome to the Backtalk API');
     done();
   });
 });