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 #446

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

breezeconcept
Copy link

Description

**Closes #443 **

Changes proposed

What were you told to do?

Implement a Health Check Endpoint that allows users to verify if the API is running properly. The endpoint should return a simple response indicating the API's status.

What did you do?

  • Added GET / endpoint in HealthCheckController.cs.
  • Created a HealthCheckResponse model for standardized API responses.
  • Integrated Swagger documentation to improve API visibility.
  • Ensured proper response formatting with HTTP status codes.

Check List (Check all the applicable boxes)

🚨 Please review the [contribution guideline](CONTRIBUTING.md) for this repository.

  • My code follows the code style of this project.
  • This PR does not contain plagiarized content.
  • The title and description of the PR is clear and explains the approach.
  • I am making a pull request against the dev branch (left side).
  • My commit messages follow the requested structure.
  • My code additions will fail neither code linting checks nor unit tests.
  • I am only making changes to files I was requested to.

Screenshots/Videos

Successful Response (200 OK)

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

Error Response (500 Internal Server Error)

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

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 this pull request may close these issues.

[FEAT] Add Health Check Endpoint
1 participant