Files
spoolman2/spoolman/api/v1/router.py
2023-07-06 23:49:14 +02:00

57 lines
1.5 KiB
Python

"""Router setup for the v1 version of the API."""
# ruff: noqa: D103
import logging
from fastapi import FastAPI
from fastapi.responses import JSONResponse
from starlette.requests import Request
from starlette.responses import Response
from spoolman.database.database import backup_task
from spoolman.exceptions import ItemNotFoundError
from . import filament, models, spool, vendor
logger = logging.getLogger(__name__)
app = FastAPI(
title="Spoolman REST API v1",
version="1.0.0",
root_path_in_servers=False,
responses={404: {"model": models.Message}},
)
@app.exception_handler(ItemNotFoundError)
async def itemnotfounderror_exception_handler(_request: Request, exc: ItemNotFoundError) -> Response:
logger.debug(exc, exc_info=True)
return JSONResponse(
status_code=404,
content={"message": exc.args[0]},
)
# Add health check endpoint
@app.get("/health")
async def health() -> models.HealthCheck:
"""Return a health check."""
return models.HealthCheck(status="healthy")
# Add endpoint for triggering a db backup
@app.post("/backup", description="Trigger a database backup. Only applicable for SQLite databases.")
async def backup() -> models.BackupResponse:
"""Trigger a database backup."""
path = await backup_task()
if path is None:
return models.BackupResponse(success=False)
return models.BackupResponse(success=True, path=str(path))
# Add routers
app.include_router(filament.router)
app.include_router(spool.router)
app.include_router(vendor.router)