Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Health endpoint GET /_/health for readiness checks

Aperta
#89 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
70/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
php
Ambito
api, backend

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
Vue
Stelle
0
Fork
0
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di components-web-app/docs

Tutte le issue di components-web-app/docs

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.