add more docs, update readme

README.md

@@ -193,6 +193,15 @@ Once 10 iterations have been exceeded, the response will change:
 
 A complete example can be found in the `DummyServiceWorker` directory.
 
+## Response Interface
+
+The `IHealthCheckResult` interface is used for returning the response data to the client. Two concrete result types are included:
+
+- An open-ended `HealthCheckResult` that requires you to serialize the payload however you require
+- The `JsonHealthCheckResult` accepts an object and automatically serializes it into JSON
+
+Inheiriting from the `IHealthCheckResult` makes it easy to create a custom implementation to return a response body of any serialization scheme.
+
 ## Hostname consideration
 
 By default, the `hostname` parameter is set to `localhost`. This will work fine for local development, but will not work across the network.

TinyHealthCheck/HealthChecks/BasicHealthCheck.cs

@@ -1,5 +1,4 @@
 using System.Net;
-using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 using TinyHealthCheck.Models;
@@ -12,6 +11,7 @@ namespace TinyHealthCheck.HealthChecks
     public class BasicHealthCheck : IHealthCheck
     {
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
+        /// <inheritdoc/>
         public async Task<IHealthCheckResult> ExecuteAsync(CancellationToken cancellationToken) =>
             new JsonHealthCheckResult(new { Status = "Healthy!" }, HttpStatusCode.OK);
 #pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously

TinyHealthCheck/HealthChecks/BasicHealthCheckWithUptime.cs

@@ -1,7 +1,5 @@
-using Microsoft.Extensions.DependencyInjection;
-using System;
+using System;
 using System.Net;
-using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 using TinyHealthCheck.Models;
@@ -16,6 +14,7 @@ public class BasicHealthCheckWithUptime : IHealthCheck
         private DateTimeOffset processStartTime = DateTimeOffset.Now;
 
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
+        /// <inheritdoc/>
         public async Task<IHealthCheckResult> ExecuteAsync(CancellationToken cancellationToken)
 #pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
         {

TinyHealthCheck/Models/HealthCheckResult.cs

@@ -2,33 +2,22 @@
 
 namespace TinyHealthCheck.Models
 {
-    /// <summary>
-    /// Container to hold the response data for an IHealthCheck. Make sure to serialze the Body object in to the specified ContentType.
-    /// </summary>
+    /// <inheritdoc/>
     public class HealthCheckResult : IHealthCheckResult
     {
         /// <summary>
-        /// Container to hold the response data for an IHealthCheck. Make sure to serialze the Body object in to the specified ContentType.
-        /// </summary>
-        public HealthCheckResult() { }
-
-        /// <summary>
-        /// Container to hold the response data for an IHealthCheck. Make sure to serialze the Body object in to the specified ContentType.
+        /// Container to hold the response data for an IHealthCheck. Make sure to serialize the Body object in to the specified ContentType.
         /// </summary>
         public HealthCheckResult(string body, HttpStatusCode statusCode)
         {
             Body = body;
             StatusCode = statusCode;
         }
 
-        /// <summary>
-        /// Serialized response body. Make sure the serialization scheme matches the ContentType defined for the health-check.
-        /// </summary>
+        /// <inheritdoc/>
         public string Body { get; set; }
 
-        /// <summary>
-        /// HTTP response code that will be returned to the client
-        /// </summary>
+        /// <inheritdoc/>
         public HttpStatusCode StatusCode { get; set; } = HttpStatusCode.OK;
     }
 }

TinyHealthCheck/Models/IHealthCheckResult.cs

@@ -2,9 +2,20 @@
 
 namespace TinyHealthCheck.Models
 {
+    /// <summary>
+    /// Container to hold the response data for an IHealthCheck. 
+    /// Make sure to serialze the Body object in to the ContentType that the health check is configured for.
+    /// </summary>
     public interface IHealthCheckResult
     {
+        /// <summary>
+        /// Serialized response body. Make sure the serialization scheme matches the ContentType defined for the health-check.
+        /// </summary>
         string Body { get; set; }
+
+        /// <summary>
+        /// HTTP response code that will be returned to the client
+        /// </summary>
         HttpStatusCode StatusCode { get; set; }
     }
 }

TinyHealthCheck/Models/JsonHealthCheckResult.cs

@@ -3,9 +3,7 @@
 
 namespace TinyHealthCheck.Models
 {
-    /// <summary>
-    /// Container to hold the response data for an IHealthCheck. Automatically serializes the response object into JSON.
-    /// </summary>
+    /// <inheritdoc/>
     public class JsonHealthCheckResult : IHealthCheckResult
     {
         /// <summary>
@@ -17,14 +15,10 @@ public JsonHealthCheckResult(object responseObject, HttpStatusCode statusCode)
             StatusCode = statusCode;
         }
 
-        /// <summary>
-        /// JSON response body
-        /// </summary>
+        /// <inheritdoc/>
         public string Body { get; set; }
 
-        /// <summary>
-        /// HTTP response code that will be returned to the client
-        /// </summary>
+        /// <inheritdoc/>
         public HttpStatusCode StatusCode { get; set; } = HttpStatusCode.OK;
     }
 }