Merge pull request #868 from emmanuel-ferdman/main

Add `/health` endpoint for service health checks

libretranslate/app.py

@@ -520,6 +520,28 @@ def create_app(args):
                          "targets": model2iso(language_pairs.get(l.code, []))
                         } for l in languages])
 
+    @bp.get("/health")
+    @limiter.exempt
+    def health():
+        """
+        Health Check
+        ---
+        tags:
+          - misc
+        responses:
+          200:
+            description: Service is healthy
+            schema:
+              id: health-response
+              type: object
+              properties:
+                status:
+                  type: string
+                  description: Health status
+                  example: ok
+        """
+        return jsonify({"status": "ok"})
+
     # Add cors
     @bp.after_request
     def after_request(response):

libretranslate/tests/test_api/test_api_health.py

@@ -0,0 +1,11 @@
+def test_api_get_health(client):
+    response = client.get("/health")
+
+    assert response.status_code == 200
+    assert response.json == {"status": "ok"}
+
+
+def test_api_health_must_fail_bad_request_type(client):
+    response = client.post("/health")
+
+    assert response.status_code == 405