operation_id_callback with blueprint name and func name (#224)

* operation_id_callback with blueprint name and func name

* Add bp_name

* Fix mypy

* Update default value

Author: luolingchun

docs/Usage/Route_Operation.md

@@ -35,7 +35,8 @@ def create_book(body: BookBody):
 
 ## summary and description
 
-You need to add docs to the view-func. The first line is the **summary**, and the rest is the **description**. Like this:
+You need to add docs to the view-func. The first line is the **summary**, and the rest is the **description**. Like
+this:
 
 ```python hl_lines="3 4 5 6"
 @app.get('/book/<int:bid>', tags=[book_tag], responses={200: BookResponse}, security=security)
@@ -67,7 +68,8 @@ def get_book(path: BookPath, query: BookBody):
 
 Allows referencing an external resource for extended documentation.
 
-More information to see [External Documentation Object](https://spec.openapis.org/oas/v3.1.0#external-documentation-object).
+More information to
+see [External Documentation Object](https://spec.openapis.org/oas/v3.1.0#external-documentation-object).
 
 ```python hl_lines="10"
 from flask_openapi3 import OpenAPI, ExternalDocumentation
@@ -110,7 +112,7 @@ Just add a `operation_id_callback` param to the constructor of  `OpenAPI` or `AP
 The example shows setting the default `operation_id` to be the function name, in this case `create_book`.
 
 ```python hl_lines="6"
-def get_operation_id_for_path(*, name: str, path: str, method: str) -> str:
+def get_operation_id_for_path(*, bp_name: str = None, name: str, path: str, method: str) -> str:
     return name
 
 api = APIBlueprint('book', __name__, url_prefix='/api', operation_id_callback=get_operation_id_for_path)
@@ -212,7 +214,8 @@ def create_book(body: BookBody):
 
 ## servers
 
-An array of Server Objects, which provide connectivity information to a target server. If the server's property is not provided, or is an empty array, the default value would be a Server Object with an url value of /.
+An array of Server Objects, which provide connectivity information to a target server. If the server's property is not
+provided, or is an empty array, the default value would be a Server Object with an url value of /.
 
 ```python
 from flask_openapi3 import OpenAPI, Server
@@ -232,11 +235,10 @@ def get_book(path: BookPath):
 
 ## openapi_extensions
 
-While the OpenAPI Specification tries to accommodate most use cases, 
+While the OpenAPI Specification tries to accommodate most use cases,
 additional data can be added to extend the specification at certain points.
 See [Specification Extensions](https://spec.openapis.org/oas/v3.1.0#specification-extensions).
 
-
 ```python  hl_lines="3 12 19 28 42"
 from flask_openapi3 import OpenAPI, APIBlueprint, APIView
 

flask_openapi3/blueprint.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 # @Author  : llc
 # @Time    : 2022/4/1 16:54
+import inspect
 from typing import Optional, Any, Callable
 
 from flask import Blueprint
@@ -162,9 +163,10 @@ def _collect_openapi_info(
                 operation.externalDocs = external_docs
 
             # Unique string used to identify the operation.
-            operation.operationId = operation_id or self.operation_id_callback(
-                name=self.name, path=rule, method=method
-            )
+            operation_id_kwargs = {"name": func.__name__, "path": rule, "method": method}
+            if "bp_name" in list(inspect.signature(self.operation_id_callback).parameters.keys()):
+                operation_id_kwargs["bp_name"] = self.name
+            operation.operationId = operation_id or self.operation_id_callback(**operation_id_kwargs)
 
             # Only set `deprecated` if True, otherwise leave it as None
             if deprecated is not None:

flask_openapi3/utils.py

@@ -102,20 +102,22 @@ def get_operation(
     return operation
 
 
-def get_operation_id_for_path(*, name: str, path: str, method: str) -> str:
+def get_operation_id_for_path(*, bp_name: str = "", name: str = "", path: str = "", method: str = "") -> str:
     """
     Generate a unique operation ID based on the name, path, and method.
 
     Args:
         name: The name or identifier for the operation.
         path: The URL path for the operation.
         method: The HTTP method for the operation.
+        bp_name: The Blueprint name
 
     Returns:
         A unique operation ID generated based on the provided name, path, and method.
 
     """
-
+    if bp_name:
+        name = bp_name + "_" + name
     return re.sub(r"\W", "_", name + path) + "_" + method.lower()
 
 

tests/test_api_blueprint.py

@@ -19,6 +19,12 @@
 }
 security_schemes = {"jwt": jwt}
 
+
+def operation_id_callback(*, bp_name: str = None, name: str, path: str, method: str) -> str:
+    assert bp_name == "/book"
+    return name
+
+
 app = OpenAPI(__name__, info=info, security_schemes=security_schemes)
 app.config["TESTING"] = True
 
@@ -37,7 +43,8 @@ class Unauthorized(BaseModel):
     url_prefix='/api',
     abp_tags=[tag],
     abp_security=security,
-    abp_responses={"401": Unauthorized}
+    abp_responses={"401": Unauthorized},
+    operation_id_callback=operation_id_callback
 )
 
 try:
@@ -104,7 +111,7 @@ def test_openapi(client):
     assert resp.status_code == 200
     assert resp.json == app.api_doc
     assert resp.json["paths"]["/api/book/{bid}"]["put"]["operationId"] == "update"
-    assert resp.json["paths"]["/api/book/{bid}"]["delete"]["operationId"] == "_book_book__int_bid__delete"
+    assert resp.json["paths"]["/api/book/{bid}"]["delete"]["operationId"] == "delete_book"
 
 
 def test_post(client):

tests/test_options_in_viewfunc.py

@@ -49,7 +49,7 @@ def test_openapi(client):
     assert resp.status_code == 200
     assert resp.json == app.api_doc
     assert resp.json["paths"]["/book"]["get"]["operationId"] == "get_book_book_get"  # Default operation_id generator
-    assert resp.json["paths"]["/api/book"]["post"]["operationId"] == "/book"  # Custom callback operation_id
+    assert resp.json["paths"]["/api/book"]["post"]["operationId"] == "create_book"  # Custom callback operation_id
 
 
 def test_get(client):