feat: #317: add health-check endpoint

src/api/health-check/controllers/health-check.ts

@@ -0,0 +1,8 @@
+module.exports = {
+  async check(ctx) {
+    ctx.body = {
+      status: 'OK',
+      timestamp: new Date()
+    };
+  },
+};

src/api/health-check/routes/health-check.ts

@@ -0,0 +1,12 @@
+module.exports = {
+  routes: [
+    {
+      method: 'GET',
+      path: '/health-check',
+      handler: 'health-check.check',
+      config: {
+        auth: false,
+      },
+    },
+  ],
+};

src/index.ts

@@ -23,11 +23,18 @@ export default {
       .service("plugin::users-permissions.role")
       .findOne(roles.filter((role) => role.type === "public")[0].id);
 
+    // When launching the application, it ticks the boxes to enable API methods.
     Object.keys(_public.permissions)
       .filter((permission) => permission.startsWith('api'))
       .forEach((permission) => {
         const controller = Object.keys(_public.permissions[permission].controllers)[0];
 
+        // Enable check for health-check
+        if (permission === 'api::health-check') {
+          _public.permissions[permission].controllers[controller].check.enabled = true;
+          return;
+        }
+
         // Enable find
         _public.permissions[permission].controllers[controller].find.enabled = true;
 
@@ -39,7 +46,7 @@ export default {
         if (_public.permissions[permission].controllers[controller].create)
           _public.permissions[permission].controllers[controller].create.enabled = true;
 
-        // Enable findOme if exists
+        // Enable findOne if exists
         if (_public.permissions[permission].controllers[controller].findOne)
           _public.permissions[permission].controllers[controller].findOne.enabled = true;
 
@@ -51,6 +58,7 @@ export default {
     // Enable find
     _public.permissions['plugin::upload'].controllers['content-api'].find.enabled = true;
 
+    // Enable upload
     _public.permissions['plugin::upload'].controllers['content-api'].upload.enabled = true;
 
     // Enable destroy