Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] Add Health Check Endpoint #443

Open
3 tasks
breezeconcept opened this issue Mar 2, 2025 · 0 comments · May be fixed by #446
Open
3 tasks

[FEAT] Add Health Check Endpoint #443

breezeconcept opened this issue Mar 2, 2025 · 0 comments · May be fixed by #446

Comments

@breezeconcept
Copy link

breezeconcept commented Mar 2, 2025

Description

Create a simple health check endpoint to verify that the API is running correctly. The endpoint should return a JSON response confirming the server status. This will help with monitoring and debugging by providing a quick way to check if the backend is operational.

Acceptance Criteria

  • Create a new GET endpoint at /
  • The endpoint should return a 200 OK status code
  • The response body should follow this structure:
    {
      "status_code": 200,
      "message": "Welcome to C-Sharp Backend Endpoint"
    }

Requirements

  • Method: GET
  • URL: /
  • Headers: application/json

Response

Successful Response (200 OK)

{
  "status_code": 200,
  "message": "Welcome to C-Sharp Backend Endpoint"
}

Error Response (500 Internal Server Error, if any issue occurs)

{
  "status_code": 500,
  "message": "Internal Server Error"
}
@breezeconcept breezeconcept linked a pull request Mar 2, 2025 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant