Allow to override validate_response_callback

Author: luolingchun

docs/Usage/Response.md

@@ -80,6 +80,19 @@ def endpoint_test(body: BaseRequest):
     ...
 ```
 
+You can also customize the default behavior of response validation by using a custom `validate_response_callback`.
+
+```python
+
+def validate_response_callback(response: Any, responses: Optional[ResponseDict] = None) -> Any:
+    
+    # do something
+    
+    return response
+
+app = OpenAPI(__name__, validate_response=True, validate_response_callback=validate_response_callback)
+```
+
 ## More information about OpenAPI responses
 
 - [OpenAPI Responses Object](https://spec.openapis.org/oas/v3.1.0#responses-object), it includes the Response Object.

flask_openapi3/models/components.py

@@ -3,7 +3,7 @@
 # @Time    : 2023/7/4 9:36
 from typing import Optional, Union, Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel
 
 from .callback import Callback
 from .example import Example
@@ -23,7 +23,7 @@ class Components(BaseModel):
     https://spec.openapis.org/oas/v3.1.0#components-object
     """
 
-    schemas: Optional[dict[str, Union[Reference, Schema]]] = Field(None)
+    schemas: Optional[dict[str, Union[Reference, Schema]]] = None
     responses: Optional[dict[str, Union[Response, Reference]]] = None
     parameters: Optional[dict[str, Union[Parameter, Reference]]] = None
     examples: Optional[dict[str, Union[Example, Reference]]] = None

flask_openapi3/openapi.py

@@ -42,6 +42,7 @@
 from .utils import parse_and_store_tags
 from .utils import parse_method
 from .utils import parse_parameters
+from .utils import run_validate_response
 from .view import APIView
 
 
@@ -64,6 +65,7 @@ def __init__(
             doc_prefix: str = "/openapi",
             doc_url: str = "/openapi.json",
             validate_response: Optional[bool] = None,
+            validate_response_callback: Callable = run_validate_response,
             **kwargs: Any
     ) -> None:
         """
@@ -97,6 +99,7 @@ def __init__(
             doc_url: URL for accessing the OpenAPI specification document in JSON format.
                 Defaults to "/openapi.json".
             validate_response: Verify the response body.
+            validate_response_callback: Validation and return response.
             **kwargs: Additional kwargs to be passed to Flask.
         """
         super(OpenAPI, self).__init__(import_name, **kwargs)
@@ -148,6 +151,7 @@ def __init__(
 
         # Verify the response body
         self.validate_response = validate_response
+        self.validate_response_callback = validate_response_callback
 
         # Initialize specification JSON
         self.spec_json: dict = {}

flask_openapi3/scaffold.py

@@ -15,7 +15,6 @@
 from .types import ParametersTuple
 from .types import ResponseDict
 from .utils import HTTPMethod
-from .utils import run_validate_response
 
 
 class APIScaffold:
@@ -105,7 +104,8 @@ async def view_func(**kwargs) -> FlaskResponse:
                     _validate_response = validate_response
 
                 if _validate_response and responses:
-                    run_validate_response(response, responses)
+                    validate_response_callback = getattr(current_app, "validate_response_callback")
+                    return validate_response_callback(response, responses)
 
                 return response
         else:
@@ -141,9 +141,10 @@ def view_func(**kwargs) -> FlaskResponse:
                         _validate_response = validate_response
                 else:
                     _validate_response = validate_response
-                
+
                 if _validate_response and responses:
-                    run_validate_response(response, responses)
+                    validate_response_callback = getattr(current_app, "validate_response_callback")
+                    return validate_response_callback(response, responses)
 
                 return response
 

flask_openapi3/utils.py

@@ -592,17 +592,17 @@ def make_validation_error_response(e: ValidationError) -> FlaskResponse:
     return response
 
 
-def run_validate_response(response: Any, responses: Optional[ResponseDict] = None) -> None:
+def run_validate_response(response: Any, responses: Optional[ResponseDict] = None) -> Any:
     """Validate response"""
     if responses is None:
-        return
+        return response
 
     if isinstance(response, tuple):  # noqa
         _resp, status_code = response[:2]
     elif isinstance(response, FlaskResponse):
         if response.mimetype != "application/json":
             # only application/json
-            return
+            return response
         _resp, status_code = response.json, response.status_code  # noqa
     else:
         _resp, status_code = response, 200
@@ -614,7 +614,7 @@ def run_validate_response(response: Any, responses: Optional[ResponseDict] = Non
     resp_model = responses.get(status_code)
 
     if resp_model is None:
-        return
+        return response
 
     assert inspect.isclass(resp_model) and \
            issubclass(resp_model, BaseModel), f"{resp_model} is invalid `pydantic.BaseModel`"
@@ -624,6 +624,8 @@ def run_validate_response(response: Any, responses: Optional[ResponseDict] = Non
     else:
         resp_model.model_validate(_resp)
 
+    return response
+
 
 def parse_rule(rule: str, url_prefix=None) -> str:
     trail_slash = rule.endswith("/")