Skip to content

Implement API Health Check Route 🏥 #4

@Sappymukherjee214

Description

@Sappymukherjee214

🚀 Is your feature request related to a problem? Please describe.

Currently, there is no quick way to verify if the backend server is running correctly without calling a key business logic endpoint (like /api/humanize), which is inefficient for basic monitoring or for developers during local setup.

💡 Describe the solution you'd like

I would like to add a simple GET /api/health endpoint in the Node.js/Express backend. This endpoint should:

  • Return a 200 OK HTTP status code.
  • Provide a JSON response containing the server status ("UP"), the current server uptime, and a timestamp.
  • Be publicly accessible and serve as a lightweight "heartbeat" for the environment.

🎨 Describe alternatives you've considered

An alternative is checking the console logs to see if the server started, but an automated health check is much better for external monitoring tools or automated setup scripts.

📝 Additional context

This route should be implemented in the main Express index.ts or a new HealthController.ts within the backend/src/controllers directory. It should be lightweight and avoid hitting the database.

Metadata

Metadata

Assignees

No one assigned

    Labels

    GSSoC '26backendTo help contributors filter issues related to the Node/Express/Prisma logic.good first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions