OpenAPI app and high level integration

README.rst

@@ -57,22 +57,20 @@ Alternatively you can download the code and install from the repository:
 First steps
 ###########
 
-Firstly create your specification object.
+Firstly create your OpenAPI object.
 
 .. code-block:: python
 
-    from jsonschema_path import SchemaPath
+    from openapi_core import OpenAPI
 
-    spec = SchemaPath.from_file_path('openapi.json')
+    openapi = OpenAPI.from_file_path('openapi.json')
 
 Now you can use it to validate and unmarshal against requests and/or responses. 
 
 .. code-block:: python
 
-    from openapi_core import unmarshal_request
-
     # raises error if request is invalid
-    result = unmarshal_request(request, spec=spec)
+    result = openapi.unmarshal_request(request)
 
 Retrieve validated and unmarshalled request data
 

docs/customizations.rst

@@ -9,13 +9,15 @@ By default, the specified specification is also validated.
 If you know you have a valid specification already, disabling the validator can improve the performance.
 
 .. code-block:: python
-  :emphasize-lines: 4
+  :emphasize-lines: 1,4,6
 
-    validate_request(
-       request,
-       spec=spec,
+    from openapi_core import Config
+
+    config = Config(
        spec_validator_cls=None,
     )
+    openapi = OpenAPI.from_file_path('openapi.json', config=config)
+    openapi.validate_request(request)
 
 Media type deserializers
 ------------------------
@@ -25,7 +27,7 @@ OpenAPI comes with a set of built-in media type deserializers such as: ``applica
 You can also define your own ones. Pass custom defined media type deserializers dictionary with supported mimetypes as a key to `unmarshal_response` function:
 
 .. code-block:: python
-  :emphasize-lines: 13
+  :emphasize-lines: 11
 
     def protobuf_deserializer(message):
        feature = route_guide_pb2.Feature()
@@ -36,11 +38,12 @@ You can also define your own ones. Pass custom defined media type deserializers
        'application/protobuf': protobuf_deserializer,
     }
 
-    result = unmarshal_response(
-       request, response,
-       spec=spec,
+    config = Config(
        extra_media_type_deserializers=extra_media_type_deserializers,
     )
+    openapi = OpenAPI.from_file_path('openapi.json', config=config)
+
+    result = openapi.unmarshal_response(request, response)
 
 Format validators
 -----------------
@@ -52,7 +55,7 @@ OpenAPI comes with a set of built-in format validators, but it's also possible t
 Here's how you could add support for a ``usdate`` format that handles dates of the form MM/DD/YYYY:
 
 .. code-block:: python
-  :emphasize-lines: 13
+  :emphasize-lines: 11
 
     import re
 
@@ -63,11 +66,12 @@ Here's how you could add support for a ``usdate`` format that handles dates of t
        'usdate': validate_usdate,
     }
 
-    validate_response(
-       request, response,
-       spec=spec,
+    config = Config(
        extra_format_validators=extra_format_validators,
     )
+    openapi = OpenAPI.from_file_path('openapi.json', config=config)
+
+    openapi.validate_response(request, response)
 
 Format unmarshallers
 --------------------
@@ -79,7 +83,7 @@ Openapi-core comes with a set of built-in format unmarshallers, but it's also po
 Here's an example with the ``usdate`` format that converts a value to date object:
 
 .. code-block:: python
-  :emphasize-lines: 13
+  :emphasize-lines: 11
 
     from datetime import datetime
 
@@ -90,8 +94,9 @@ Here's an example with the ``usdate`` format that converts a value to date objec
        'usdate': unmarshal_usdate,
     }
 
-    result = unmarshal_response(
-       request, response,
-       spec=spec,
+    config = Config(
        extra_format_unmarshallers=extra_format_unmarshallers,
     )
+    openapi = OpenAPI.from_file_path('openapi.json', config=config)
+
+    result = openapi.unmarshal_response(request, response)

docs/index.rst

@@ -45,22 +45,20 @@ Installation
 First steps
 -----------
 
-Firstly create your specification object.
+Firstly create your OpenAPI object.
 
 .. code-block:: python
 
-    from jsonschema_path import SchemaPath
+    from openapi_core import OpenAPI
 
-    spec = SchemaPath.from_file_path('openapi.json')
+    openapi = OpenAPI.from_file_path('openapi.json')
 
 Now you can use it to validate and unmarshal your requests and/or responses. 
 
 .. code-block:: python
 
-    from openapi_core import unmarshal_request
-
     # raises error if request is invalid
-    result = unmarshal_request(request, spec=spec)
+    result = openapi.unmarshal_request(request)
 
 Retrieve validated and unmarshalled request data
 

docs/integrations.rst

@@ -48,35 +48,35 @@ The integration supports Django from version 3.0 and above.
 Middleware
 ~~~~~~~~~~
 
-Django can be integrated by middleware. Add ``DjangoOpenAPIMiddleware`` to your ``MIDDLEWARE`` list and define ``OPENAPI_SPEC``.
+Django can be integrated by middleware. Add ``DjangoOpenAPIMiddleware`` to your ``MIDDLEWARE`` list and define ``OPENAPI``.
 
 .. code-block:: python
   :emphasize-lines: 6,9
 
     # settings.py
-    from jsonschema_path import SchemaPath
+    from openapi_core import OpenAPI
 
     MIDDLEWARE = [
        # ...
        'openapi_core.contrib.django.middlewares.DjangoOpenAPIMiddleware',
     ]
 
-    OPENAPI_SPEC = SchemaPath.from_dict(spec_dict)
+    OPENAPI = OpenAPI.from_dict(spec_dict)
 
 You can skip response validation process: by setting ``OPENAPI_RESPONSE_CLS`` to ``None``
 
 .. code-block:: python
   :emphasize-lines: 10
 
     # settings.py
-    from jsonschema_path import SchemaPath
+    from openapi_core import OpenAPI
 
     MIDDLEWARE = [
        # ...
        'openapi_core.contrib.django.middlewares.DjangoOpenAPIMiddleware',
     ]
 
-    OPENAPI_SPEC = SchemaPath.from_dict(spec_dict)
+    OPENAPI = OpenAPI.from_dict(spec_dict)
     OPENAPI_RESPONSE_CLS = None
 
 After that you have access to unmarshal result object with all validated request data from Django view through request object.

openapi_core/__init__.py

@@ -1,4 +1,6 @@
 """OpenAPI core module"""
+from openapi_core.app import OpenAPI
+from openapi_core.configurations import Config
 from openapi_core.shortcuts import unmarshal_apicall_request
 from openapi_core.shortcuts import unmarshal_apicall_response
 from openapi_core.shortcuts import unmarshal_request
@@ -11,7 +13,7 @@
 from openapi_core.shortcuts import validate_response
 from openapi_core.shortcuts import validate_webhook_request
 from openapi_core.shortcuts import validate_webhook_response
-from openapi_core.spec import Spec
+from openapi_core.spec.paths import Spec
 from openapi_core.unmarshalling.request import V3RequestUnmarshaller
 from openapi_core.unmarshalling.request import V3WebhookRequestUnmarshaller
 from openapi_core.unmarshalling.request import V30RequestUnmarshaller
@@ -40,6 +42,8 @@
 __license__ = "BSD 3-Clause License"
 
 __all__ = [
+    "OpenAPI",
+    "Config",
     "Spec",
     "unmarshal_request",
     "unmarshal_response",