Merge pull request #206 from thevahidal/move-health-endpoint

Move health endpoint

package.json

@@ -1,6 +1,6 @@
 {
   "name": "soul-cli",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "A SQLite REST and Realtime server",
   "main": "src/server.js",
   "bin": {
@@ -51,7 +51,7 @@
     "eslint-config-prettier": "^9.0.0",
     "husky": "^8.0.3",
     "jest": "^29.4.3",
-    "nodemon": "^2.0.20",
+    "nodemon": "^3.1.3",
     "prettier": "3.1.0",
     "supertest": "^6.3.3",
     "swagger-autogen": "^2.23.1"

src/controllers/index.js

@@ -17,6 +17,17 @@ const root = async (req, res) => {
   });
 };
 
+const health = async (req, res) => {
+  /*
+    #swagger.tags = ['Root']
+    #swagger.summary = 'Health Check'
+    #swagger.description = 'Endpoint to return server health status'
+  */
+
+  res.send('OK');
+};
+
 module.exports = {
   root,
+  health,
 };

src/controllers/index.test.js

@@ -14,3 +14,11 @@ describe('Root Endpoints', () => {
     expect(res.body.data).toHaveProperty('timestamp');
   });
 });
+
+describe('Health Endpoints', () => {
+  it('GET /health should return server version and timestamp', async () => {
+    const res = await requestWithSupertest.get('/api/health');
+    expect(res.status).toEqual(200);
+    expect(res.type).toEqual(expect.stringContaining('text'));
+  });
+});

src/index.js

@@ -28,10 +28,8 @@ const {
 
 const { runCLICommands } = require('./commands');
 const { authConstants } = require('./constants');
+
 const app = express();
-app.get('/health', (req, res) => {
-  res.send('OK');
-});
 
 app.use(bodyParser.json());
 app.use(cookieParser());

src/routes/index.js

@@ -5,5 +5,6 @@ const controllers = require('../controllers/index');
 const router = express.Router();
 
 router.get('/', controllers.root);
+router.get('/health', controllers.health);
 
 module.exports = router;

src/swagger/swagger.json

@@ -30,9 +30,11 @@
   "consumes": ["application/json"],
   "produces": ["application/json"],
   "paths": {
-    "/health": {
+    "/api/": {
       "get": {
-        "description": "",
+        "tags": ["Root"],
+        "summary": "Timestamp",
+        "description": "Endpoint to return server timestamp",
         "parameters": [],
         "responses": {
           "200": {
@@ -41,11 +43,11 @@
         }
       }
     },
-    "/api/": {
+    "/api/health": {
       "get": {
         "tags": ["Root"],
-        "summary": "Timestamp",
-        "description": "Endpoint to return server timestamp",
+        "summary": "Health Check",
+        "description": "Endpoint to return server health status",
         "parameters": [],
         "responses": {
           "200": {
@@ -865,7 +867,7 @@
       "properties": {
         "message": {
           "type": "string",
-          "example": "This password is weak, please use another password"
+          "example": "This password is weak, it should be at least 8 characters long and contain a combination of lowercase letters, uppercase letters, numbers, and special characters"
         }
       }
     },