Allow url_prefix to be set during API/APIView registration (#215)

* Allow url_prefix to be set during API/APIView registration

* Add tests

Author: luolingchun

.github/workflows/tests.yml

@@ -23,7 +23,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12", "3.13" ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
         flask-version: [ "Flask>=2.0,<3.0", "Flask>=3.0" ]
     env:
       PYTHONPATH: .

flask_openapi3/openapi.py

@@ -280,13 +280,19 @@ def generate_spec_json(self):
                     }
                 }
 
-    def register_api(self, api: APIBlueprint) -> None:
+    def register_api(self, api: APIBlueprint, **options: Any) -> None:
         """
         Register an APIBlueprint.
 
         Args:
             api: The APIBlueprint instance to register.
 
+            options: Additional keyword arguments are passed to :class:`~flask.blueprints.BlueprintSetupState`.
+            They can be accessed in :meth:`~flask.Blueprint.record` callbacks.
+            url_prefix, Blueprint routes will be prefixed with this.
+            subdomain, Blueprint routes will match on this subdomain.
+            url_defaults, Blueprint routes will use these default values for view arguments.
+
         """
         for tag in api.tags:
             if tag.name not in self.tag_names:
@@ -297,20 +303,31 @@ def register_api(self, api: APIBlueprint) -> None:
                 self.tag_names.append(tag.name)
 
         # Update paths with the APIBlueprint's paths
+        url_prefix = options.get("url_prefix")
+        if url_prefix and api.url_prefix and url_prefix != api.url_prefix:
+            api.paths = {url_prefix + k.removeprefix(api.url_prefix): v for k, v in api.paths.items()}
+        elif url_prefix and not api.url_prefix:
+            api.paths = {url_prefix.rstrip("/") + "/" + k.lstrip("/"): v for k, v in api.paths.items()}
         self.paths.update(**api.paths)
 
         # Update component schemas with the APIBlueprint's component schemas
         self.components_schemas.update(**api.components_schemas)
 
         # Register the APIBlueprint with the current instance
-        self.register_blueprint(api)
+        self.register_blueprint(api, **options)
 
-    def register_api_view(self, api_view: APIView, view_kwargs: Optional[Dict[Any, Any]] = None) -> None:
+    def register_api_view(
+            self,
+            api_view: APIView,
+            url_prefix: Optional[str] = None,
+            view_kwargs: Optional[Dict[Any, Any]] = None
+    ) -> None:
         """
         Register APIView
 
         Args:
             api_view: The APIView instance to register.
+            url_prefix: A path to prepend to all the APIView's urls
             view_kwargs: Additional keyword arguments to pass to the API views.
         """
         if view_kwargs is None:
@@ -326,13 +343,17 @@ def register_api_view(self, api_view: APIView, view_kwargs: Optional[Dict[Any, A
                 self.tag_names.append(tag.name)
 
         # Update paths with the APIView's paths
+        if url_prefix and api_view.url_prefix and url_prefix != api_view.url_prefix:
+            api_view.paths = {url_prefix + k.removeprefix(api_view.url_prefix): v for k, v in api_view.paths.items()}
+        elif url_prefix and not api_view.url_prefix:
+            api_view.paths = {url_prefix.rstrip("/") + "/" + k.lstrip("/"): v for k, v in api_view.paths.items()}
         self.paths.update(**api_view.paths)
 
         # Update component schemas with the APIView's component schemas
         self.components_schemas.update(**api_view.components_schemas)
 
         # Register the APIView with the current instance
-        api_view.register(self, view_kwargs=view_kwargs)
+        api_view.register(self, url_prefix=url_prefix, view_kwargs=view_kwargs)
 
     def _add_url_rule(
             self,

flask_openapi3/view.py

@@ -190,12 +190,18 @@ def decorator(func):
 
         return decorator
 
-    def register(self, app: "OpenAPI", view_kwargs: Optional[Dict[Any, Any]] = None) -> None:
+    def register(
+            self,
+            app: "OpenAPI",
+            url_prefix: Optional[str] = None,
+            view_kwargs: Optional[Dict[Any, Any]] = None
+    ) -> None:
         """
         Register the API views with the given OpenAPI app.
 
         Args:
             app: An instance of the OpenAPI app.
+            url_prefix: A path to prepend to all the APIView's urls
             view_kwargs: Additional keyword arguments to pass to the API views.
         """
         for rule, (cls, methods) in self.views.items():
@@ -214,6 +220,12 @@ def register(self, app: "OpenAPI", view_kwargs: Optional[Dict[Any, Any]] = None)
                     view_class=cls,
                     view_kwargs=view_kwargs
                 )
+
+                if url_prefix and self.url_prefix and url_prefix != self.url_prefix:
+                    rule = url_prefix + rule.removeprefix(self.url_prefix)
+                elif url_prefix and not self.url_prefix:
+                    rule = url_prefix.rstrip("/") + "/" + rule.lstrip("/")
+
                 options = {
                     "endpoint": cls.__name__ + "." + method.lower(),
                     "methods": [method.upper()]

tests/test_url_prefix.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2025/1/15 9:58
+import pytest
+
+from flask_openapi3 import APIBlueprint, OpenAPI, APIView
+
+app = OpenAPI(__name__, )
+app.config["TESTING"] = True
+
+
+@pytest.fixture
+def client():
+    client = app.test_client()
+
+    return client
+
+
+api1 = APIBlueprint("/book1", __name__, url_prefix="/api")
+api2 = APIBlueprint("/book2", __name__)
+
+
+@api1.get("/book")
+def create_book1():
+    return "ok"
+
+
+@api2.get("/book")
+def create_book2():
+    return "ok"
+
+
+app.register_api(api1, url_prefix="/api1")
+app.register_api(api2, url_prefix="/api2")
+
+api_view1 = APIView(url_prefix="/api")
+api_view2 = APIView()
+
+
+@api_view1.route("/book")
+class BookAPIView:
+    @api_view1.doc(summary="get book")
+    def get(self):
+        return "ok"
+
+
+@api_view2.route("/book")
+class BookAPIView2:
+    @api_view2.doc(summary="get book")
+    def get(self, ):
+        return "ok"
+
+
+app.register_api_view(api_view1, url_prefix="/api3")
+app.register_api_view(api_view2, url_prefix="/api4")
+
+
+def test_openapi(client):
+    resp = client.get("/openapi/openapi.json")
+    _json = resp.json
+    assert "/api1/book" in _json["paths"].keys()
+    assert "/api2/book" in _json["paths"].keys()
+    assert "/api3/book" in _json["paths"].keys()
+    assert "/api4/book" in _json["paths"].keys()