Merge pull request #4178 from gofiber/claude/update-healthcheck-endpoints

Author: ReneWerner87

docs/middleware/healthcheck.md

@@ -18,6 +18,8 @@ app.Get(healthcheck.StartupEndpoint, healthcheck.New())
 
 By default the probe returns `true`, so each endpoint responds with `200 OK`; returning `false` yields `503 Service Unavailable`.
 
+The default response format is plain text, but you can configure the middleware to return responses in JSON, XML, MessagePack, or CBOR formats.
+
 - **Liveness**: Checks if the server is running.
 - **Readiness**: Checks if the application is ready to handle requests.
 - **Startup**: Checks if the application has completed its startup sequence.
@@ -61,6 +63,49 @@ The middleware responds only to GET. Use `app.All` to expose a probe on every me
 app.All("/healthz", healthcheck.New())
 ```
 
+### Response Formats
+
+You can configure the response format using the `ResponseFormat` field in the config:
+
+```go
+import (
+    "github.com/gofiber/fiber/v3"
+    "github.com/gofiber/fiber/v3/middleware/healthcheck"
+)
+
+// JSON format
+app.Get(healthcheck.LivenessEndpoint, healthcheck.New(healthcheck.Config{
+    ResponseFormat: healthcheck.FormatJSON,
+}))
+// Response: {"status":"OK"}
+
+// XML format
+app.Get(healthcheck.ReadinessEndpoint, healthcheck.New(healthcheck.Config{
+    ResponseFormat: healthcheck.FormatXML,
+}))
+// Response: <healthResponse><status>OK</status></healthResponse>
+```
+
+**Note:** MessagePack and CBOR formats require configuring the appropriate encoders in your Fiber app:
+
+```go
+import (
+    "github.com/fxamacker/cbor/v2"
+    "github.com/gofiber/fiber/v3"
+    "github.com/gofiber/fiber/v3/middleware/healthcheck"
+    "github.com/shamaton/msgpack/v3"
+)
+
+app := fiber.New(fiber.Config{
+    MsgPackEncoder: msgpack.Marshal,
+    CBOREncoder:    cbor.Marshal,
+})
+
+app.Get(healthcheck.LivenessEndpoint, healthcheck.New(healthcheck.Config{
+    ResponseFormat: healthcheck.FormatMsgPack,
+}))
+```
+
 ## Config
 
 ```go
@@ -78,9 +123,29 @@ type Config struct {
     //
     // Optional. Default: func(c fiber.Ctx) bool { return true }
     Probe func(fiber.Ctx) bool
+
+    // ResponseFormat specifies the format of the healthcheck response.
+    // Supported formats: Text (default), JSON, XML, MsgPack, CBOR.
+    //
+    // Optional. Default: FormatText
+    ResponseFormat ResponseFormat
 }
 ```
 
+### Response Format Constants
+
+```go
+type ResponseFormat int
+
+const (
+    FormatText    ResponseFormat = iota // Plain text response (default)
+    FormatJSON                          // JSON response
+    FormatXML                           // XML response
+    FormatMsgPack                       // MessagePack response
+    FormatCBOR                          // CBOR response
+)
+```
+
 ## Default Config
 
 The default configuration used by this middleware is defined as follows:

middleware/healthcheck/config.go

@@ -4,6 +4,22 @@ import (
 	"github.com/gofiber/fiber/v3"
 )
 
+// ResponseFormat defines the format of the healthcheck response.
+type ResponseFormat int
+
+const (
+	// FormatText returns a plain text response (default behavior).
+	FormatText ResponseFormat = iota
+	// FormatJSON returns a JSON response.
+	FormatJSON
+	// FormatXML returns an XML response.
+	FormatXML
+	// FormatMsgPack returns a MessagePack response.
+	FormatMsgPack
+	// FormatCBOR returns a CBOR response.
+	FormatCBOR
+)
+
 // Config defines the configuration options for the healthcheck middleware.
 type Config struct {
 	// Next defines a function to skip this middleware when returned true. If this function returns true
@@ -18,6 +34,12 @@ type Config struct {
 	//
 	// Optional. Default: func(c fiber.Ctx) bool { return true }
 	Probe func(fiber.Ctx) bool
+
+	// ResponseFormat specifies the format of the healthcheck response.
+	// Supported formats: Text (default), JSON, XML, MsgPack, CBOR.
+	//
+	// Optional. Default: FormatText
+	ResponseFormat ResponseFormat
 }
 
 const (

middleware/healthcheck/healthcheck.go

@@ -4,6 +4,11 @@ import (
 	"github.com/gofiber/fiber/v3"
 )
 
+// healthResponse represents the JSON/XML/MsgPack/CBOR response structure.
+type healthResponse struct {
+	Status string `json:"status" xml:"status" msgpack:"status" cbor:"status"`
+}
+
 // New returns a health-check handler that responds based on the provided
 // configuration.
 func New(config ...Config) fiber.Handler {
@@ -19,10 +24,30 @@ func New(config ...Config) fiber.Handler {
 			return c.Next()
 		}
 
-		if cfg.Probe(c) {
-			return c.SendStatus(fiber.StatusOK)
+		healthy := cfg.Probe(c)
+		statusCode := fiber.StatusOK
+		statusMessage := "OK"
+
+		if !healthy {
+			statusCode = fiber.StatusServiceUnavailable
+			statusMessage = "Service Unavailable"
 		}
 
-		return c.SendStatus(fiber.StatusServiceUnavailable)
+		// Set the status code
+		c.Status(statusCode)
+
+		// Return response based on configured format
+		switch cfg.ResponseFormat {
+		case FormatJSON:
+			return c.JSON(healthResponse{Status: statusMessage})
+		case FormatXML:
+			return c.XML(healthResponse{Status: statusMessage})
+		case FormatMsgPack:
+			return c.MsgPack(healthResponse{Status: statusMessage})
+		case FormatCBOR:
+			return c.CBOR(healthResponse{Status: statusMessage})
+		default: // FormatText
+			return c.SendString(statusMessage)
+		}
 	}
 }