Fix thing_descriptions and things endpoints.

I'd accidentally modified these endpoints (and deleted `things`) when I changed the function that added them.

I've now added tests for these endpoints, and fixed the URL generation in `things`.

Author: rwb27

src/labthings_fastapi/server/__init__.py

@@ -342,6 +342,11 @@ def _things_view_router(self) -> APIRouter:
         router = APIRouter()
         thing_server = self
 
+        @router.get(
+            "/thing_descriptions/",
+            response_model_exclude_none=True,
+            response_model_by_alias=True,
+        )
         def thing_descriptions(request: Request) -> Mapping[str, ThingDescription]:
             """Describe all the things available from this server.
 
@@ -362,16 +367,7 @@ def thing_descriptions(request: Request) -> Mapping[str, ThingDescription]:
                 for name, thing in thing_server.things.items()
             }
 
-        router.add_api_route(
-            "/thing_descriptions/",
-            thing_descriptions,
-            response_model_exclude_none=True,
-            response_model_by_alias=True,
-        )
-
-        return router
-
-        @self.app.get("/things/")
+        @router.get("/things/")
         def thing_paths(request: Request) -> Mapping[str, str]:
             """URLs pointing to the Thing Descriptions of each Thing.
 
@@ -381,6 +377,8 @@ def thing_paths(request: Request) -> Mapping[str, str]:
                 URLs will return the :ref:`wot_td` of one `.Thing` each.
             """  # noqa: D403 (URLs is correct capitalisation)
             return {
-                t: f"{str(request.base_url).rstrip('/')}{t}"
+                t: str(request.url_for(f"things.{t}"))
                 for t in thing_server.things.keys()
             }
+
+        return router

src/labthings_fastapi/thing.py

@@ -176,6 +176,7 @@ def attach_to_server(self, server: ThingServer) -> None:
 
         @server.app.get(
             self.path,
+            name=f"things.{self.name}",
             summary=get_summary(self.thing_description),
             description=get_docstring(self.thing_description),
             response_model_exclude_none=True,

tests/test_server.py

@@ -9,6 +9,8 @@
 from fastapi.testclient import TestClient
 from starlette.routing import Route
 
+from labthings_fastapi.example_things import MyThing
+
 
 def test_server_from_config_non_thing_error():
     """Test a typeerror is raised if something that's not a Thing is added."""
@@ -81,6 +83,7 @@ class Example(lt.Thing):
         "/api/v3/action_invocations/{id}",
         "/api/v3/blob/{blob_id}",
         "/api/v3/thing_descriptions/",
+        "/api/v3/things/",
         "/api/v3/example/",
     ]:
         assert expected_path in paths
@@ -92,3 +95,33 @@ class Example(lt.Thing):
         "/docs/oauth2-redirect",
         "/redoc",
     }
+
+
+def test_things_endpoints():
+    """Test that the two endpoints for listing Things work."""
+    server = lt.ThingServer(
+        {
+            "thing_a": MyThing,
+            "thing_b": MyThing,
+        }
+    )
+    with TestClient(server.app) as client:
+        # Check the thing_descriptions endpoint
+        response = client.get("/thing_descriptions/")
+        response.raise_for_status()
+        tds = response.json()
+        assert "thing_a" in tds
+        assert "thing_b" in tds
+
+        # Check the things endpoint. This should map names to URLs
+        response = client.get("/things/")
+        response.raise_for_status()
+        things = response.json()
+        assert "thing_a" in things
+        assert "thing_b" in things
+
+        # Fetch a thing description from the URL in `things`
+        response = client.get(things["thing_a"])
+        response.raise_for_status()
+        td = response.json()
+        assert td["title"] == "MyThing"