Add support for tags in routes (#42)

ioxiocom · Apr 8, 2024 · b6907bd · b6907bd
1 parent 44ae03e
commit b6907bd
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 35 deletions.
diff --git a/openapi_to_fastapi/parser.py b/openapi_to_fastapi/parser.py
@@ -70,6 +70,7 @@ def parse_operation(spec: dict, name: str) -> Optional[Operation]:
     operation.summary = data.get("summary")
     operation.description = data.get("description")
     operation.deprecated = data.get("deprecated")
+    operation.tags = data.get("tags")
 
     request_body_model = get_model_name_from_ref(data.get("requestBody", {}))
     if request_body_model:

diff --git a/openapi_to_fastapi/routes.py b/openapi_to_fastapi/routes.py
@@ -127,9 +127,10 @@ def _validate_and_parse_specs(self, cleanup=True):
                     route_info = RouteInfo(
                         request_model=req_model,
                         description=post.description,
-                        summary=path_item.post.summary,
-                        headers=path_item.post.headers,
-                        deprecated=path_item.post.deprecated,
+                        tags=post.tags,
+                        summary=post.summary,
+                        headers=post.headers,
+                        deprecated=post.deprecated,
                         responses={},
                     )
 

diff --git a/openapi_to_fastapi/tests/data/definitions/CoffeeBrewer.json b/openapi_to_fastapi/tests/data/definitions/CoffeeBrewer.json
@@ -11,6 +11,7 @@
         "summary": "Coffee brewer",
         "description": "Coffee brewer",
         "operationId": "request_draft_Appliances_CoffeeBrewer",
+        "tags": ["Coffee"],
         "parameters": [
           {
             "description": "Optional consent token",

diff --git a/openapi_to_fastapi/tests/test_router.py b/openapi_to_fastapi/tests/test_router.py
@@ -216,6 +216,16 @@ def test_deprecated(app, specs_root):
     assert spec["paths"]["/draft/Appliances/CoffeeBrewer"]["post"]["deprecated"] is True
 
 
+def test_tags(app, specs_root):
+    spec_router = SpecRouter(specs_root / "definitions")
+
+    router = spec_router.to_fastapi_router()
+    app.include_router(router)
+
+    spec = app.openapi()
+    assert spec["paths"]["/draft/Appliances/CoffeeBrewer"]["post"]["tags"] == ["Coffee"]
+
+
 def test_custom_responses(app, specs_root):
     brew_spec = "/draft/Appliances/CoffeeBrewer"
     spec_router = SpecRouter(specs_root / "definitions")

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openapi-to-fastapi"
-version = "0.14.0"
+version = "0.15.0"
 description = "Create FastAPI routes from OpenAPI spec"
 authors = ["IOXIO Ltd"]
 license = "BSD-3-Clause"