warn user if operation id is not unique (#80, #70)

ninja/openapi/schema.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, Type
 
 from pydantic import BaseModel
@@ -27,6 +28,7 @@ def __init__(self, api: "NinjaAPI", path_prefix: str) -> None:
         self.path_prefix = path_prefix
         self.schemas: DictStrAny = {}
         self.securitySchemes: DictStrAny = {}
+        self.all_operation_ids: Set = set()
         super().__init__(
             [
                 ("openapi", "3.0.2"),
@@ -52,7 +54,7 @@ def get_paths(self) -> DictStrAny:
                 full_path = normalize_path(full_path)
                 path_methods = self.methods(path_view.operations)
                 if path_methods:
-                    result[full_path] = self.methods(path_view.operations)
+                    result[full_path] = path_methods
         return result
 
     def methods(self, operations: list) -> DictStrAny:
@@ -66,6 +68,11 @@ def methods(self, operations: list) -> DictStrAny:
 
     def operation_details(self, operation: Operation) -> DictStrAny:
         op_id = operation.operation_id or self.api.get_openapi_operation_id(operation)
+        if op_id in self.all_operation_ids:
+            warnings.warn(
+                f'operation_id "{op_id}" is already used (func: {operation.view_func})'
+            )
+        self.all_operation_ids.add(op_id)
         result = {
             "operationId": op_id,
             "summary": operation.summary,

tests/test_auth.py

@@ -63,7 +63,7 @@ def demo_operation(request):
     ("basic", BasicAuth()),
     ("bearer", BearerAuth()),
 ]:
-    api.get(f"/{path}", auth=auth)(demo_operation)
+    api.get(f"/{path}", auth=auth, operation_id=path)(demo_operation)
 
 
 client = NinjaClient(api)

tests/test_inheritance_routers.py

@@ -14,23 +14,23 @@ def global_op(request):
 
 
 @first_router.get("/endpoint")
-def router_op(request):
+def router_op1(request):
     return "first"
 
 
 second_router_one = Router()
 
 
 @second_router_one.get("endpoint_1")
-def router_op(request):
+def router_op2(request):
     return "second 1"
 
 
 second_router_two = Router()
 
 
 @second_router_two.get("endpoint_2")
-def router_op(request):
+def router_op3(request):
     return "second 2"
 
 

tests/test_openapi_schema.py

@@ -1,8 +1,7 @@
+import pytest
 from typing import List
-from unittest.mock import patch
 from ninja import NinjaAPI, Schema
 from django.test import Client, override_settings
-from copy import copy
 
 
 api = NinjaAPI()
@@ -122,3 +121,19 @@ def test_schema():
             "type": "object",
         },
     }
+
+
+def test_unique_operation_ids():
+
+    api = NinjaAPI()
+
+    @api.get("/1")
+    def same_name(request):
+        pass
+
+    @api.get("/2")
+    def same_name(request):
+        pass
+
+    with pytest.warns(UserWarning):
+        schema = api.get_openapi_schema()