mirror of
https://github.com/correl/tornado-openapi3.git
synced 2024-11-22 03:00:15 +00:00
81 lines
2.7 KiB
ReStructuredText
81 lines
2.7 KiB
ReStructuredText
===================
|
|
Tornado OpenAPI 3
|
|
===================
|
|
|
|
.. image:: https://travis-ci.com/correl/tornado-openapi3.svg?branch=master
|
|
:target: https://travis-ci.com/correl/tornado-openapi3
|
|
.. image:: https://codecov.io/gh/correl/tornado-openapi3/branch/master/graph/badge.svg?token=CTYWWDXTL9
|
|
:target: https://codecov.io/gh/correl/tornado-openapi3
|
|
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
:target: https://github.com/psf/black
|
|
|
|
|
|
Tornado OpenAPI 3 request and response validation library.
|
|
|
|
Provides integration between the `Tornado`_ web framework and `Openapi-core`_
|
|
library for validating request and response objects against an `OpenAPI 3`_
|
|
specification.
|
|
|
|
|
|
.. _Tornado: https://www.tornadoweb.org/
|
|
.. _Openapi-core: https://github.com/p1c2u/openapi-core
|
|
.. _OpenAPI 3: https://swagger.io/specification/
|
|
|
|
|
|
Adding validation to request handlers
|
|
=====================================
|
|
|
|
.. code:: python
|
|
|
|
from openapi_core import create_spec # type: ignore
|
|
from openapi_core.exceptions import OpenAPIError # type: ignore
|
|
from openapi_core.deserializing.exceptions import DeserializeError # type: ignore
|
|
from openapi_core.schema.media_types.exceptions import ( # type: ignore
|
|
InvalidContentType,
|
|
)
|
|
from openapi_core.unmarshalling.schemas.exceptions import ValidateError # type: ignore
|
|
from tornado.web import RequestHandler
|
|
from tornado_openapi3 import RequestValidator
|
|
import yaml
|
|
|
|
|
|
class OpenAPIRequestHandler(RequestHandler):
|
|
async def prepare(self) -> None:
|
|
maybe_coro = super().prepare()
|
|
if maybe_coro and asyncio.iscoroutine(maybe_coro): # pragma: no cover
|
|
await maybe_coro
|
|
|
|
spec = create_spec(yaml.safe_load(self.render_string("openapi.yaml")))
|
|
validator = RequestValidator(spec)
|
|
result = validator.validate(self.request)
|
|
try:
|
|
result.raise_for_errors()
|
|
except InvalidContentType:
|
|
self.set_status(415)
|
|
self.finish()
|
|
except (DeserializeError, ValidateError) as e:
|
|
self.set_status(400)
|
|
self.finish()
|
|
except OpenAPIError:
|
|
raise
|
|
|
|
Validating a response
|
|
=====================
|
|
|
|
.. code:: python
|
|
|
|
from tornado.testing import AsyncHTTPTestCase
|
|
from tornado_openapi3 import ResponseValidator
|
|
|
|
from myapplication import create_app, spec
|
|
|
|
|
|
class TestResponses(AsyncHTTPTestCase):
|
|
def get_app(self) -> Application:
|
|
return create_app()
|
|
|
|
def test_status(self) -> None:
|
|
validator = ResponseValidator(spec)
|
|
response = self.fetch("/status")
|
|
result = validator.validate(response)
|
|
result.raise_for_errors()
|