health check api route documented and tested

Author: Robert Kummer

app/Http/Controllers/Api/HealthController.php

@@ -2,6 +2,8 @@
 
 namespace App\Http\Controllers\Api;
 
+use Illuminate\Http\JsonResponse;
+
 class HealthController extends ApiController
 {
     public function health()
@@ -13,7 +15,14 @@ public function health()
         return $this->respond(200, 'healthy');
     }
 
-    private function respond($code, $message)
+    /**
+     * responds given data as json
+     *
+     * @param int $code
+     * @param string $message
+     * @return \Illuminate\Http\JsonResponse
+     */
+    private function respond(int $code, string $message): JsonResponse
     {
         $data = [
             'status' => $code,

tests/Feature/Api/HealthResourceTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Tests\Feature\Api;
+
+use Tests\TestCase;
+
+class HealthResourceTest extends TestCase
+{
+    /** @test */
+    public function it_can_access_the_health_check_resource()
+    {
+        // ARRANGE
+
+    	// ACT
+        $response = $this->get('/api/health');
+
+    	// ASSERT
+    	$response->assertStatus(200);
+    }
+
+}