Implement health check endpoint

Author: KroderDev

README.md

@@ -251,6 +251,35 @@ You no longer need to stack `jwt.auth` + `load.access` manually—just use `micr
 
 ---
 
+## Endpoints
+
+### Health Check Endpoint
+
+This package exposes a JSON endpoint at `/api/health` providing basic service details.
+
+#### Configuration (`config/microservice.php`)
+
+```php
+'health' => [
+    'enabled' => env('HEALTH_ENDPOINT_ENABLED', true),
+    'path'    => '/api/health',
+],
+```
+
+When enabled (default), visiting `/api/health` returns:
+
+```json
+{
+  "status": "ok",
+  "app": "your-app-name",
+  "environment": "testing",
+  "laravel": "12.x-dev",
+  "timestamp": "2025-01-01T12:00:00Z"
+}
+```
+
+---
+
 ## Public Release and Future Goals
 
 This repository is brand new, and I’m excited to develop it further! My plan is to continuously strengthen the core, add more middleware modules, expand test coverage, and refine configuration options.  

src/Http/HealthCheckController.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Kroderdev\LaravelMicroserviceCore\Http;
+
+use Illuminate\Http\JsonResponse;
+
+class HealthCheckController
+{
+    public function __invoke(): JsonResponse
+    {
+        return response()->json([
+            'status' => 'ok',
+            'app' => config('app.name'),
+            'environment' => app()->environment(),
+            'laravel' => app()->version(),
+            'timestamp' => now()->toIso8601String(),
+        ]);
+    }
+}

src/Providers/MicroserviceServiceProvider.php

@@ -7,6 +7,7 @@
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\ServiceProvider;
 use Kroderdev\LaravelMicroserviceCore\Contracts\ApiGatewayClientInterface;
+use Kroderdev\LaravelMicroserviceCore\Http\HealthCheckController;
 use Kroderdev\LaravelMicroserviceCore\Http\Middleware\LoadAccess;
 use Kroderdev\LaravelMicroserviceCore\Http\Middleware\PermissionMiddleware;
 use Kroderdev\LaravelMicroserviceCore\Http\Middleware\RoleMiddleware;
@@ -78,6 +79,12 @@ public function boot(Router $router): void
             LoadAccess::class,
         ]);
 
+        // Health check route
+        if (config('microservice.health.enabled', true)) {
+            $path = ltrim(config('microservice.health.path', '/api/health'), '/');
+            $router->get('/' . $path, HealthCheckController::class);
+        }
+
         // HTTP
         Http::macro('apiGateway', function () {
             // Correlation ID

src/config/microservice.php

@@ -117,6 +117,19 @@
         'url' => env('API_GATEWAY_URL', 'http://gateway.local'),
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Health Endpoint
+    |--------------------------------------------------------------------------
+    |
+    | Enable or disable registration of the default /api/health route.
+    |
+    */
+    'health' => [
+        'enabled' => env('HEALTH_ENDPOINT_ENABLED', true),
+        'path'    => '/api/health',
+    ],
+
     /*
     |--------------------------------------------------------------------------
     | Permissions Cache

tests/Http/HealthCheckTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Tests\Http;
+
+use Orchestra\Testbench\TestCase;
+use Kroderdev\LaravelMicroserviceCore\Providers\MicroserviceServiceProvider;
+
+class HealthCheckTest extends TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [MicroserviceServiceProvider::class];
+    }
+
+    /** @test */
+    public function health_endpoint_returns_200()
+    {
+        $response = $this->get('/api/health');
+
+        $response->assertStatus(200)
+                 ->assertJsonStructure([
+                     'status',
+                     'app',
+                     'environment',
+                     'laravel',
+                     'timestamp',
+                 ]);
+    }
+}