Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Health endpoint GET /_/health for readiness checks

オープン
#89 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
70/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
php
領域
api, backend

調査の方向性

The health endpoint needs to be added to the routing in routing/all.php. Start by examining the existing API routes and the access control configuration. Implement a controller or handler that performs a dummy database select and returns the appropriate JSON response with the correct HTTP status codes and cache headers. Test the endpoint to ensure it works without authentication and is excluded from caching.

索引モデルが issue の本文から書いたものです。

説明

documentation

Source: components-web-app/api-components-bundle#312 (PR #315)

GET /_api/_/health (the /_/health route under the application's API prefix):

  • 200 {"status":"ok"} after a dummy select on the default database connection; 503 {"status":"unavailable","reason":"database"} otherwise.
  • Never cached (Cache-Control: no-store), no surrogate keys, no session; cheap enough to probe every few seconds. Use it for Docker/compose healthchecks and Kubernetes readiness probes, and exclude it from Souin's cache.
  • Imported through routing/all.php. An application whose access_control requires login for every GET must allow it: { path: ^/_api/_/health, roles: PUBLIC_ACCESS }.
  • Only the database is checked; optional services (Mercure, the cache) don't fail it.
主要言語
Vue
スター
0
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

components-web-app/docs のほかの issue

components-web-app/docs の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。