File: aiohttp.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 (41 lines) | stat: -rw-r--r-- 1,256 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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
aiohttp.web
===========

This section describes integration with `aiohttp.web <https://docs.aiohttp.org/en/stable/web.html>`__ framework.

Low level
---------

The integration defines classes useful for low level integration.

Request
^^^^^^^

Use ``AIOHTTPOpenAPIWebRequest`` to create OpenAPI request from aiohttp.web request:

.. code-block:: python

    from openapi_core.contrib.aiohttp import AIOHTTPOpenAPIWebRequest

    async def hello(request):
        request_body = await request.text()
        openapi_request = AIOHTTPOpenAPIWebRequest(request, body=request_body)
        openapi.validate_request(openapi_request)
        return web.Response(text="Hello, world")

Response
^^^^^^^^

Use ``AIOHTTPOpenAPIWebResponse`` to create OpenAPI response from aiohttp.web response:

.. code-block:: python

    from openapi_core.contrib.starlette import AIOHTTPOpenAPIWebResponse

    async def hello(request):
        request_body = await request.text()
        response = web.Response(text="Hello, world")
        openapi_request = AIOHTTPOpenAPIWebRequest(request, body=request_body)
        openapi_response = AIOHTTPOpenAPIWebResponse(response)
        result = openapi.unmarshal_response(openapi_request, openapi_response)
        return response