GET /health

[benjaspet]

Description

Link to Issue

This pull request features a simple GET /health endpoint to monitor the backend's API health. Backend health checks are a good practice because they allow us to properly monitor anything that could prevent our API from servicing incoming requests in the way that it should.

How Has This Been Tested?

This has been testing using Postman and a simple unit test I wrote:

t.Run("GetHealth", func(t *testing.T) {

	resp, err := http.Get("http://localhost:8080/health")
	if err != nil {
		log.Fatalln(err)
	}

	if err != nil {
		t.Errorf("expected no error, got %v", err)
	}

	if resp.StatusCode != http.StatusOK {
		t.Errorf("expected status 200, got %d", resp.StatusCode)
	}

})

Note that I removed this test temporarily to pass GH Actions tests that could not run the backend in parallel.

Checklist

• I have performed a self-review of my code
• I have reached out to another developer to review my code
• I have commented my code, particularly in hard-to-understand areas
• New and existing unit tests pass locally with my changes