Add k8s liveness & readiness

README.md

@@ -34,6 +34,7 @@ XDev helps with daily development tasks like formatting JSON, base64 encoding /
 - [Usage](#usage)
 - [Architecture](#architecture)
 - [Docker](#docker)
+- [Kuberenetes](#kuberenetes)
 - [Web UI](#web-ui)
 - [Features](#features) 
 - [Contributing](#contributing)
@@ -148,7 +149,23 @@ If you want to use `Xdev` as server running in docker container you can use http
 
 -  `VERBOSE` To enable verbose mode.
 
-
+## Kuberenetes
+
+Healthcheck endpoint for liveness & readiness
+`GET /api/health`
+
+```
+readinessProbe:
+  httpGet:
+    path: /api/health
+ initialDelaySeconds: 10
+ periodSeconds: 10
+livenessProbe:
+  httpGet:
+    path: /api/health
+  initialDelaySeconds: 10
+  periodSeconds: 10
+```
 
 ## Web UI
 

api/root.go

@@ -5,7 +5,8 @@ import (
 )
 
 const (
-	APIPrefix = "/api"
+	APIPrefix       = "/api"
+	healthCheckPath = "/health"
 )
 
 type Response struct {
@@ -15,6 +16,7 @@ type Response struct {
 }
 
 func AddAPILayer(app *fiber.App) {
+	healthCheck(app)
 	uuidAPI(app)
 	ulidAPI(app)
 	passwordAPI(app)
@@ -27,3 +29,9 @@ func AddAPILayer(app *fiber.App) {
 	timeAPI(app)
 	propertiesAPI(app)
 }
+
+func healthCheck(app *fiber.App) {
+	app.Get(APIPrefix+healthCheckPath, func(c fiber.Ctx) error {
+		return c.JSON(Response{Success: true, Message: "OK"})
+	})
+}

api/root_test.go

@@ -0,0 +1,28 @@
+package api
+
+import (
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/gofiber/fiber/v3"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestHealthCheck(t *testing.T) {
+	app := fiber.New()
+	healthCheck(app)
+	// Create a test request
+	req := httptest.NewRequest(http.MethodGet, "/api/health", nil)
+	resp, err := app.Test(req)
+	assert.NoError(t, err)
+
+	// Check the response status code
+	assert.Equal(t, http.StatusOK, resp.StatusCode)
+
+	// Check the response body
+	body, err := io.ReadAll(resp.Body)
+	assert.NoError(t, err)
+	assert.JSONEq(t, `{"success": true, "message": "OK", "data": null}`, string(body))
+}