add ending slash

Author: CosmoV

fastapi_jsonapi/api.py

@@ -76,6 +76,7 @@ def __init__(
         pagination_default_limit: Optional[int] = None,
         methods: Iterable[str] = (),
         max_cache_size: int = 0,
+        ending_slash: bool = True,
     ) -> None:
         """
         Initialize router items.
@@ -115,6 +116,7 @@ def __init__(
         self.schema_detail = schema
         # tuple and not set, so ordering is persisted
         self.methods = tuple(methods) or self.DEFAULT_METHODS
+        self.ending_suffix = "/" if ending_slash else ""
 
         if self.type_ in self.all_jsonapi_routers:
             msg = f"Resource type {self.type_!r} already registered"
@@ -184,7 +186,7 @@ def _register_get_resource_list(self, path: str):
             status.HTTP_200_OK: {"model": self.list_response_schema},
         }
         self.router.add_api_route(
-            path=path,
+            path=path + self.ending_suffix,
             tags=self.tags,
             responses=list_response_example | self.default_error_responses,
             methods=["GET"],
@@ -198,7 +200,7 @@ def _register_post_resource_list(self, path: str):
             status.HTTP_201_CREATED: {"model": self.detail_response_schema},
         }
         self.router.add_api_route(
-            path=path,
+            path=path + self.ending_suffix,
             tags=self.tags,
             responses=create_resource_response_example | self.default_error_responses,
             methods=["POST"],
@@ -213,7 +215,7 @@ def _register_delete_resource_list(self, path: str):
             status.HTTP_200_OK: {"model": self.detail_response_schema},
         }
         self.router.add_api_route(
-            path=path,
+            path=path + self.ending_suffix,
             tags=self.tags,
             responses=detail_response_example | self.default_error_responses,
             methods=["DELETE"],
@@ -229,7 +231,7 @@ def _register_get_resource_detail(self, path: str):
         self.router.add_api_route(
             # TODO: variable path param name (set default name on DetailView class)
             # TODO: trailing slash (optional)
-            path=path + "/{obj_id}",
+            path=path + "/{obj_id}" + self.ending_suffix,
             tags=self.tags,
             responses=detail_response_example | self.default_error_responses,
             methods=["GET"],
@@ -245,7 +247,7 @@ def _register_patch_resource_detail(self, path: str):
         self.router.add_api_route(
             # TODO: variable path param name (set default name on DetailView class)
             # TODO: trailing slash (optional)
-            path=path + "/{obj_id}",
+            path=path + "/{obj_id}" + self.ending_suffix,
             tags=self.tags,
             responses=update_response_example | self.default_error_responses,
             methods=["PATCH"],
@@ -264,7 +266,7 @@ def _register_delete_resource_detail(self, path: str):
         self.router.add_api_route(
             # TODO: variable path param name (set default name on DetailView class)
             # TODO: trailing slash (optional)
-            path=path + "/{obj_id}",
+            path=path + "/{obj_id}" + self.ending_suffix,
             tags=self.tags,
             responses=delete_response_example | self.default_error_responses,
             methods=["DELETE"],

tests/test_api/test_api_sqla_with_includes.py

@@ -1277,15 +1277,15 @@ async def test_create_user_and_fetch_data(self, app: FastAPI, client: AsyncClien
             },
         }
         app.url_path_for("get_user_list")
-        res = await client.post("/users", json=create_user_body)
+        res = await client.post("/users/", json=create_user_body)
         assert res.status_code == status.HTTP_201_CREATED, res.text
         response_data = res.json()
         assert "data" in response_data, response_data
         assert response_data["data"]["attributes"] == create_user_body["data"]["attributes"]
 
         user_id = response_data["data"]["id"]
 
-        res = await client.get(f"/users/{user_id}")
+        res = await client.get(f"/users/{user_id}/")
         assert res.status_code == status.HTTP_200_OK, res.text
         response_data = res.json()
         assert "data" in response_data, response_data
@@ -2511,7 +2511,7 @@ async def test_filters_really_works(
         params = {"filter[name]": fake_name}
         assert user_1.name != fake_name
         assert user_2.name != fake_name
-        res = await client.get("/users", params=params)
+        res = await client.get("/users/", params=params)
         assert res.status_code == status.HTTP_200_OK, res.text
         assert res.json() == {
             "data": [],

tests/test_api/test_routers.py

@@ -89,7 +89,7 @@ class DependencyInjectionDetailView(DetailViewBaseGeneric):
 
     app = build_app(DependencyInjectionDetailView, resource_type="test_dependency_handler_call")
     async with AsyncClient(app=app, base_url="http://test") as client:
-        res = await client.get("/users/1")
+        res = await client.get("/users/1/")
 
         assert res.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR, res.text
         assert res.json() == {
@@ -149,7 +149,7 @@ class DependencyInjectionDetailView(DetailViewBaseGeneric):
     resource_type = "test_dependencies_as_permissions"
     app = build_app(DependencyInjectionDetailView, resource_type=resource_type)
     async with AsyncClient(app=app, base_url="http://test") as client:
-        res = await client.get(f"/users/{user_1.id}", headers={"X-AUTH": "not_admin"})
+        res = await client.get(f"/users/{user_1.id}/", headers={"X-AUTH": "not_admin"})
 
         assert res.status_code == status.HTTP_403_FORBIDDEN, res.text
         assert res.json() == {
@@ -163,7 +163,7 @@ class DependencyInjectionDetailView(DetailViewBaseGeneric):
             ],
         }
 
-        res = await client.get(f"/users/{user_1.id}", headers={"X-AUTH": "admin"})
+        res = await client.get(f"/users/{user_1.id}/", headers={"X-AUTH": "admin"})
         assert res.json() == {
             "data": {
                 "attributes": UserAttributesBaseSchema.model_validate(user_1).model_dump(),
@@ -203,7 +203,7 @@ class DependencyInjectionDetailView(DetailViewBaseGeneric):
 
     app = build_app(DependencyInjectionDetailView, resource_type="test_manipulate_data_layer_kwargs")
     async with AsyncClient(app=app, base_url="http://test") as client:
-        res = await client.get(f"/users/{user_1.id}")
+        res = await client.get(f"/users/{user_1.id}/")
 
         assert res.status_code == status.HTTP_404_NOT_FOUND, res.text
         assert res.json() == {