From dc81660eb4fe3859ad29c7095a92d0e345c71b6e Mon Sep 17 00:00:00 2001 From: p1c2u Date: Wed, 22 Nov 2023 22:28:42 +0000 Subject: [PATCH] Docs integrations restructure --- docs/index.rst | 4 ++-- docs/integrations.rst | 30 ++++++++++++++++++------------ docs/integrations/index.rst | 4 ++++ docs/integrations/werkzeug.rst | 33 +++++++++++++++++++++++++++++++++ 4 files changed, 57 insertions(+), 14 deletions(-) create mode 100644 docs/integrations/index.rst create mode 100644 docs/integrations/werkzeug.rst diff --git a/docs/index.rst b/docs/index.rst index f2defc02..393a7c68 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,11 +3,11 @@ openapi-core .. toctree:: :hidden: - :maxdepth: 2 + :maxdepth: 3 unmarshalling validation - integrations + integrations/index customizations security extensions diff --git a/docs/integrations.rst b/docs/integrations.rst index c20247c1..3c6b765f 100644 --- a/docs/integrations.rst +++ b/docs/integrations.rst @@ -491,22 +491,28 @@ This section describes integration with `Werkzeug `__ a WSGI web application library. + +Low level +~~~~~~~~~ + +The integration defines ``WerkzeugOpenAPIRequest`` and ``WerkzeugOpenAPIResponse`` classes that convert +Werkzeug requests and responses to OpenAPI ones. + +.. md-tab-set:: + + .. md-tab-item:: Request + + .. code-block:: python + + from openapi_core.contrib.werkzeug import WerkzeugOpenAPIRequest + + openapi_request = WerkzeugOpenAPIRequest(werkzeug_request) + + result = openapi.unmarshal_request(openapi_request) + + .. md-tab-item:: Response + + .. code-block:: python + + from openapi_core.contrib.werkzeug import WerkzeugOpenAPIRequest, WerkzeugOpenAPIResponse + + openapi_request = WerkzeugOpenAPIRequest(werkzeug_request) + openapi_response = WerkzeugOpenAPIResponse(werkzeug_response) + + result = openapi.unmarshal_response(openapi_request, openapi_response)