Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Health endpoint GET /_/health for readiness checks

Cerrado
  • ¿Algo no está bien?
#89 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
70/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
php
Área
api, backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Vue
Estrellas
0
Forks
0
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de components-web-app/docs

Todos los issues de components-web-app/docs

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.