File: request_unmarshaller_cls.rst

package info (click to toggle)
python-openapi-core 0.19.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,008 kB
  • sloc: python: 18,868; makefile: 47
file content (22 lines) | stat: -rw-r--r-- 738 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Request unmarshaller
====================

By default, request unmarshaller is selected based on detected specification version.

In order to explicitly validate and unmarshal a:

* OpenAPI 3.0 spec, import ``V30RequestUnmarshaller``
* OpenAPI 3.1 spec, import ``V31RequestUnmarshaller`` or ``V31WebhookRequestUnmarshaller``

.. code-block:: python
  :emphasize-lines: 1,4

    from openapi_core import V31RequestUnmarshaller

    config = Config(
       request_unmarshaller_cls=V31RequestUnmarshaller,
    )
    openapi = OpenAPI.from_file_path('openapi.json', config=config)
    result = openapi.unmarshal_request(request)

You can also explicitly import ``V3RequestUnmarshaller`` which is a shortcut to the latest OpenAPI v3 version.