get openapi docs working for figures

bored-charts/boredcharts/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.4.0"
+__version__ = "0.4.1"
 
 from boredcharts.router import BCRouter
 from boredcharts.webapp import boredcharts

bored-charts/boredcharts/router.py

@@ -41,7 +41,7 @@ def __get_pydantic_core_schema__(
 
 
 class BCRouter(APIRouter):
-    """A FastAPI APIRouter that is specifically designed for creating chart routes.
+    """A FastAPI router that turns charts into endpoints.
 
     Usage:
 
@@ -65,7 +65,7 @@ def chart(
         Creates a GET route for a chart, just a shorter form of the FastAPI get decorator,
         your function still has to return a HTMLResponse
         """
-        path = f"/figure/{name}"
+        path = name if name.startswith("/") else f"/{name}"
         return self.get(
             path=path,
             name=name,

bored-charts/boredcharts/webapp.py

@@ -1,20 +1,21 @@
 from pathlib import Path
 
-from fastapi import APIRouter, FastAPI, Request
+from fastapi import FastAPI, Request
 from fastapi.responses import HTMLResponse
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
 from jinja2 import Environment, FileSystemLoader, StrictUndefined
 from plotly.offline import get_plotlyjs
 
 from boredcharts.jinja import figure, md_to_html, row
+from boredcharts.router import BCRouter
 
 module_root = Path(__file__).parent.absolute()
 
 
 def boredcharts(
     pages: Path,
-    figure_router: APIRouter,
+    figure_router: BCRouter,
     *,
     name: str = "bored-charts",
 ) -> FastAPI:
@@ -23,7 +24,7 @@ def boredcharts(
     templates_root = module_root / "templates"
     Path(static_root / "plotlyjs.min.js").write_text(get_plotlyjs())
 
-    app = FastAPI()
+    app = FastAPI(title=name)
 
     app.mount(
         "/static",
@@ -78,6 +79,8 @@ async def report(report_name: str, request: Request) -> HTMLResponse:
             },
         )
 
-    app.mount("/", figure_router)
+    if figure_router.tags is None or len(figure_router.tags) == 0:
+        figure_router.tags = ["figures"]
+    app.include_router(figure_router, prefix="/figures")
 
     return app

tests/test_routes.py

@@ -1,15 +1,15 @@
 from pathlib import Path
 
+from boredcharts.router import BCRouter
 from boredcharts.webapp import boredcharts
-from fastapi import APIRouter
 from fastapi.testclient import TestClient
 
 
 def test_healthz() -> None:
     client = TestClient(
         boredcharts(
             pages=Path(__file__).parent / "pages",
-            figure_router=APIRouter(),
+            figure_router=BCRouter(),
         )
     )
     response = client.get("/healthz")