README

概述

此Bundle为Symfony应用程序提供一个迷你框架，以查询其当前“健康状况”。具体来说，“健康”和“不健康”的含义取决于应用程序，必须进行定义。然而，创建用于查询（并提供健康报告）的Symfony控制器和命令的样板代码已由Bundle处理。

安装此Bundle的唯一支持方法是使用composer

composer require cushon/health-bundle

当认为服务不健康时，API端点将默认返回500状态代码。您可以通过将以下内容添加到您的Symfony配置YAML文件中来配置它

    cushon_health:
        error_response_code: !php/const Symfony\Component\HttpFoundation\Response::HTTP_SERVICE_UNAVAILABLE

注意，上述代码片段显示了一个错误响应代码为503。您可以在此处指定任何状态代码，包括如果您愿意的200。

bin/console cushon:health

输出示例

默认端点是/health。

请参阅创建依赖项检查的部分。

/src: 包含Bundle代码。与标准设计略有不同，但遵循Symfony Bundle System的标准。

/docs: 项目的文档和指标汇总。

以下文件和目录不包括在发布中，以降低存档复杂性。如果您想查看整个项目，您可以选择本地克隆项目或不在您的composer文件中优先选择分发。

/app - 包含一个用于运行集成和行为测试的Symfony 6应用程序，并提供了示例

/docker - 包含用于运行API示例的Dockerfile和nginx配置，并用于针对PHP版本进行测试。项目根目录中的docker-compose.yml也被移除了。

/features - 包含Gherkin简化场景，用于驱动行为测试并提供示例规格说明。

/tests - 使用发布版本时，测试将被排除。

此外，运行测试和质量工具的文件（例如 infection.json、phpunit.xml.dist）也将被省略。

该组件分别使用phpUnit和behat进行单元测试和行为测试。