Endpoints

Endpoints

This package provides a set of HTTP endpoints to help monitor and interact with your Laravel microservice. Each endpoint is configurable and designed to support common operational and integration needs.

Health Check

A JSON endpoint at /api/health reports basic service details.

'health' => [
    'enabled' => env('HEALTH_ENDPOINT_ENABLED', true),
    'path'    => '/api/health',
],

Example response:

{
  "status": "ok",
  "app": "your-app-name",
  "environment": "testing",
  "laravel": "12.x-dev",
  "timestamp": "2025-01-01T12:00:00Z"
}