Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Health endpoint GET /_/health for readiness checks

Đã đóng
  • Có gì không ổn?
#89 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
70/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
php
Lĩnh vực
api, backend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
1 giờ 20 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của components-web-app/docs

Tất cả issue của components-web-app/docs

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.