Spaces:

Pyboxs
/

kaiobash-server

Runtime error

Silicon Valley - Admin commited on Dec 2, 2024

Commit

53b7d1b

1 Parent(s): 49a61bb

Enhance server.py and Dockerfile for improved API documentation and static file handling

- Added a new static directory for serving Swagger UI files.
- Introduced an endpoint to serve the Swagger UI and OpenAPI specification.
- Updated requirements.txt to include PyYAML for YAML file handling.
- Modified Dockerfile to create a directory for static files during the build process.

Files changed (4) hide show

Dockerfile +3 -0
requirements.txt +2 -1
server.py +16 -6
static/swagger.html +37 -0

Dockerfile CHANGED Viewed

@@ -15,6 +15,9 @@ COPY requirements.txt .
 RUN pip install --no-cache-dir --upgrade pip && \
     pip install --no-cache-dir -r requirements.txt
 # Copiar el resto de los archivos
 COPY . .

 RUN pip install --no-cache-dir --upgrade pip && \
     pip install --no-cache-dir -r requirements.txt
+# Crear directorio para archivos estáticos
+RUN mkdir -p /code/static
 # Copiar el resto de los archivos
 COPY . .

requirements.txt CHANGED Viewed

@@ -8,4 +8,5 @@ python-json-logger==2.0.7
 prometheus-client==0.17.1
 pydantic==1.10.13
 python-dotenv==1.0.0
-uvicorn==0.24.0

 prometheus-client==0.17.1
 pydantic==1.10.13
 python-dotenv==1.0.0
+uvicorn==0.24.0
+PyYAML==6.0.1

server.py CHANGED Viewed

@@ -4,9 +4,11 @@ import secrets
 import logging
 import asyncio
 import json
 from typing import Tuple
-from quart import Quart, websocket, request
 from quart_schema import QuartSchema, validate_request, validate_response
 from quart_cors import cors
 from uvicorn.middleware.proxy_headers import ProxyHeadersMiddleware
@@ -33,6 +35,11 @@ app.logger.setLevel(LOG_LEVEL)
 broker = SessionBroker()
 # Modelos de datos
 @dataclass
 class Status:
@@ -78,6 +85,14 @@ class ErrorResponse:
     error: str
 # Rutas API
 @app.get("/status")
 @validate_response(Status)
 async def status() -> Status:
@@ -163,11 +178,6 @@ async def write(data: Write) -> Tuple[WriteResponse | ErrorResponse, int]:
     except asyncio.TimeoutError:
         return ErrorResponse('Timeout when waiting for client.'), 500
-# Agregar un endpoint de health check y root
-@app.route("/")
-async def root():
-    return {"message": "Kaio API Server", "version": VERSION}
 @app.route("/health")
 async def health_check():
     return {"status": "healthy"}

 import logging
 import asyncio
 import json
+import yaml
+from pathlib import Path
 from typing import Tuple
+from quart import Quart, websocket, request, send_from_directory
 from quart_schema import QuartSchema, validate_request, validate_response
 from quart_cors import cors
 from uvicorn.middleware.proxy_headers import ProxyHeadersMiddleware
 broker = SessionBroker()
+# Cargar OpenAPI spec
+OPENAPI_PATH = Path(__file__).parent / "openapi.yaml"
+with open(OPENAPI_PATH) as f:
+    openapi_spec = yaml.safe_load(f)
 # Modelos de datos
 @dataclass
 class Status:
     error: str
 # Rutas API
+@app.route('/')
+async def swagger_ui():
+    return await send_from_directory('static', 'swagger.html')
+@app.route('/openapi.yaml')
+async def openapi():
+    return openapi_spec
 @app.get("/status")
 @validate_response(Status)
 async def status() -> Status:
     except asyncio.TimeoutError:
         return ErrorResponse('Timeout when waiting for client.'), 500
 @app.route("/health")
 async def health_check():
     return {"status": "healthy"}

static/swagger.html ADDED Viewed

	@@ -0,0 +1,37 @@

+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Kaio API - Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui.css">
+    <link rel="icon" type="image/png" href="https://cdn.jsdelivr.net/npm/[email protected]/favicon-32x32.png" sizes="32x32" />
+    <style>
+        html { box-sizing: border-box; overflow: -moz-scrollbars-vertical; overflow-y: scroll; }
+        *, *:before, *:after { box-sizing: inherit; }
+        body { margin: 0; background: #fafafa; }
+    </style>
+</head>
+<body>
+    <div id="swagger-ui"></div>
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui-bundle.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui-standalone-preset.js"></script>
+    <script>
+        window.onload = function() {
+            const ui = SwaggerUIBundle({
+                url: "/openapi.yaml",
+                dom_id: '#swagger-ui',
+                deepLinking: true,
+                presets: [
+                    SwaggerUIBundle.presets.apis,
+                    SwaggerUIStandalonePreset
+                ],
+                plugins: [
+                    SwaggerUIBundle.plugins.DownloadUrl
+                ],
+                layout: "StandaloneLayout"
+            });
+            window.ui = ui;
+        };
+    </script>
+</body>
+</html>