Merge pull request #46 from bytes-zone/health-endpoint

health endpoint

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.2 (2025-01-04)
+
+Add a `/health` endpoint to the server for healthchecks in environments like Kubernetes.
+
+This release is available as a container image at `ghcr.io/bytes-zone/beeps:v0.4.2`.
+
 ## 0.4.1 (2025-01-04)
 
 Version updates for all packages. The server is now available as a container image now, too! You can find it at `ghcr.io/bytes-zone/beeps:v0.4.1`.

beeps-server/src/handlers.rs

@@ -1,5 +1,6 @@
 #![expect(clippy::missing_docs_in_private_items)]
 
+pub mod health;
 pub mod login;
 pub mod register;
 pub mod whoami;

beeps-server/src/handlers/health.rs

@@ -0,0 +1,14 @@
+#[tracing::instrument]
+pub async fn handler() -> &'static str {
+    "OK"
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test_log::test(tokio::test)]
+    async fn test_success() {
+        assert_eq!(handler().await, "OK")
+    }
+}

beeps-server/src/main.rs

@@ -103,6 +103,7 @@ async fn main() {
 
     let app = Router::new()
         // ROUTES
+        .route("/health", get(handlers::health::handler))
         .route("/api/v1/register", post(handlers::register::handler))
         .route("/api/v1/login", post(handlers::login::handler))
         .route("/api/v1/whoami", get(handlers::whoami::handler))