mainlycode/health-bundle

Symfony bundle for adding a /health endpoint to your application

0.4.0 2024-06-18 08:43 UTC

Requires

• php: ^8.2
• symfony/http-foundation: ^5.4||^6.4||^7.0

Requires (Dev)

• phpunit/phpunit: ^10.4
• symfony/browser-kit: ^5.4||^6.4||^7.0
• symfony/framework-bundle: ^5.4||^6.4||^7.0
• symfony/yaml: ^5.4||^6.4||^7.0

MIT

• othillo

README

Symfony bundle for adding a /health endpoint to your application

Installation

Install the bundle with Composer:

composer require mainlycode/health-bundle

Register the bundle in your application (config/bundles.php):

return [
    /** your other bundles */
    MainlyCode\HealthBundle\HealthBundle::class => ['all' => true],
];

To add the route to your application, add the following to your config/routing.yaml:

health:
    resource: '@HealthBundle/config/routing.yaml'

or if you are importing routes in PHP:

// config/routes.php
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes) {
    $routes->import('@HealthBundle/config/routing.yaml');
};