Add FastAPIModule routes_url and openapi_url parameters (#148)

Author: davidbrochart

src/fps/web/fastapi.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
 from fastapi import FastAPI
+from fastapi.routing import APIRoute, APIWebSocketRoute
+from starlette import routing
 
 from fps import Module
 
@@ -12,10 +14,38 @@ def __init__(
         *,
         app: FastAPI | None = None,
         debug: bool | None = None,
+        routes_url: str | None = None,
+        openapi_url: str | None = "/openapi.json",
     ) -> None:
         super().__init__(name)
         debug = debug if debug is not None else __debug__
-        self.app = app if app is not None else FastAPI(debug=debug)
+        self.app = (
+            app if app is not None else FastAPI(debug=debug, openapi_url=openapi_url)
+        )
+        self.routes_url = routes_url
 
     async def prepare(self) -> None:
         self.put(self.app)
+
+    async def start(self) -> None:
+        if self.routes_url is not None:
+            routes = []
+            name: str | None
+            for route in self.app.routes:
+                if isinstance(route, APIWebSocketRoute):
+                    path = route.path
+                    name = route.name
+                    methods = ["WEBSOCKET"]
+                elif isinstance(route, routing.Mount):
+                    path = route.path
+                    name = route.name
+                    methods = ["MOUNT"]
+                elif isinstance(route, APIRoute):
+                    path = route.path
+                    name = route.name
+                    methods = list(route.methods)
+                routes.append({"path": path, "name": name, "methods": methods})
+
+            @self.app.get(self.routes_url)
+            async def get_routes():
+                return routes

tests/test_web.py

@@ -2,6 +2,7 @@
 
 import httpx
 from fastapi import FastAPI
+from fastapi.staticfiles import StaticFiles
 
 from fps import Module
 from fps.web.fastapi import FastAPIModule
@@ -31,3 +32,54 @@ def __init__(self, name):
             response = await client.get(f"http://127.0.0.1:{unused_tcp_port}")
 
     assert response.json() == {"Hello": "World"}
+
+
+async def test_routes(unused_tcp_port):
+    class Submodule0(Module):
+        async def prepare(self):
+            app = await self.get(FastAPI)
+
+            @app.get("/get")
+            def get(): ...
+
+            @app.websocket("/websocket")
+            def websocket(): ...
+
+            app.mount("/static", StaticFiles(directory="."), name="static")
+
+    class Module0(Module):
+        def __init__(self, name):
+            super().__init__(name)
+            self.add_module(
+                FastAPIModule, "fastapi_module", openapi_url=None, routes_url="/routes"
+            )
+            self.add_module(ServerModule, "server_module", port=unused_tcp_port)
+            self.add_module(Submodule0, "submodule0")
+
+    async with Module0("module0"):
+        async with httpx.AsyncClient() as client:
+            response = await client.get(f"http://127.0.0.1:{unused_tcp_port}/routes")
+
+    assert response.json() == [
+        {
+            "methods": [
+                "GET",
+            ],
+            "name": "get",
+            "path": "/get",
+        },
+        {
+            "methods": [
+                "WEBSOCKET",
+            ],
+            "name": "websocket",
+            "path": "/websocket",
+        },
+        {
+            "methods": [
+                "MOUNT",
+            ],
+            "name": "static",
+            "path": "/static",
+        },
+    ]