(api) Add nice index page

nuclearcat · nuclearcat · commit c2b3b566c4ba · 2025-06-08T00:20:38.000Z
Signed-off-by: Denys Fedoryshchenko &lt;denys.f@collabora.com&gt;
diff --git a/api/main.py b/api/main.py
@@ -28,7 +28,7 @@
     Body,
 )
 from fastapi.encoders import jsonable_encoder
-from fastapi.responses import JSONResponse, PlainTextResponse, FileResponse
+from fastapi.responses import JSONResponse, PlainTextResponse, FileResponse, HTMLResponse
 from fastapi.security import OAuth2PasswordRequestForm
 from fastapi_pagination import add_pagination
 from fastapi_versioning import VersionedFastAPI
@@ -132,7 +132,10 @@ async def invalid_id_exception_handler(
 async def root():
     """Root endpoint handler"""
     metrics.add('http_requests_total', 1)
-    return {"message": "KernelCI API"}
+    root_dir = os.path.dirname(os.path.abspath(__file__))
+    index_path = os.path.join(root_dir, 'templates', 'index.html')
+    with open(index_path, 'r', encoding='utf-8') as file:
+        return HTMLResponse(file.read())
 
 # -----------------------------------------------------------------------------
 # Users
diff --git a/api/templates/index.html b/api/templates/index.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>KernelCI API Server</title>
+    <style>
+        body { font-family: Arial, sans-serif; background: #f8f9fa; color: #222; margin: 0; padding: 0; }
+        .container { max-width: 600px; margin: 60px auto; background: #fff; border-radius: 10px; box-shadow: 0 2px 8px rgba(0,0,0,0.07); padding: 32px; }
+        h1 { color: #0057b7; }
+        a { color: #0057b7; text-decoration: none; }
+        a:hover { text-decoration: underline; }
+        .logo { width: 120px; margin-bottom: 24px; }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <img src="https://kernelci.org/wp-content/uploads/sites/92/2019/10/kernelci-horizontal-color.svg" alt="KernelCI Logo" class="logo"/>
+        <h1>KernelCI API Server</h1>
+        <p>Welcome! This is the <b>KernelCI API</b> server endpoint.</p>
+        <p>Use this service to interact with the KernelCI Maestro API via RESTful API calls.</p>
+        <p>For more information about KernelCI, please visit <a href="https://kernelci.org/" target="_blank">kernelci.org</a>.</p>
+        <p>API documentation and usage instructions can be found in the <a href="https://docs.kernelci.org/" target="_blank">KernelCI documentation</a>.</p>
+        <hr/>
+        <p style="font-size: 0.95em; color: #888;">&copy; 2025 KernelCI Project</p>
+    </div>
+</body>
+</html> 
