mirror of
https://github.com/correl/openapi-core.git
synced 2024-12-01 03:00:09 +00:00
138 lines
3.8 KiB
ReStructuredText
138 lines
3.8 KiB
ReStructuredText
************
|
|
openapi-core
|
|
************
|
|
|
|
.. image:: https://img.shields.io/pypi/v/openapi-core.svg
|
|
:target: https://pypi.python.org/pypi/openapi-core
|
|
.. image:: https://travis-ci.org/p1c2u/openapi-core.svg?branch=master
|
|
:target: https://travis-ci.org/p1c2u/openapi-core
|
|
.. image:: https://img.shields.io/codecov/c/github/p1c2u/openapi-core/master.svg?style=flat
|
|
:target: https://codecov.io/github/p1c2u/openapi-core?branch=master
|
|
.. image:: https://img.shields.io/pypi/pyversions/openapi-core.svg
|
|
:target: https://pypi.python.org/pypi/openapi-core
|
|
.. image:: https://img.shields.io/pypi/format/openapi-core.svg
|
|
:target: https://pypi.python.org/pypi/openapi-core
|
|
.. image:: https://img.shields.io/pypi/status/openapi-core.svg
|
|
:target: https://pypi.python.org/pypi/openapi-core
|
|
|
|
About
|
|
#####
|
|
|
|
Openapi-core is a Python library that adds client-side and server-side support
|
|
for the `OpenAPI Specification v3 <https://github.com/OAI/OpenAPI-Specification>`__.
|
|
|
|
Key features
|
|
************
|
|
|
|
* **Validation** of requests and responses
|
|
* Schema **casting** and **unmarshalling**
|
|
* Media type and parameters **deserialization**
|
|
* **Security** providers (API keys, Cookie, Basic and Bearer HTTP authentications)
|
|
* Custom **deserializers** and **formats**
|
|
* **Integration** with libraries and frameworks
|
|
|
|
|
|
Documentation
|
|
#############
|
|
|
|
Check documentation to see more details about the features. All documentation is in the "docs" directory and online at `openapi-core.readthedocs.io <https://openapi-core.readthedocs.io>`__
|
|
|
|
|
|
Installation
|
|
############
|
|
|
|
Recommended way (via pip):
|
|
|
|
::
|
|
|
|
$ pip install openapi-core
|
|
|
|
Alternatively you can download the code and install from the repository:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install -e git+https://github.com/p1c2u/openapi-core.git#egg=openapi_core
|
|
|
|
|
|
Usage
|
|
#####
|
|
|
|
Firstly create your specification:
|
|
|
|
.. code-block:: python
|
|
|
|
from openapi_core import create_spec
|
|
|
|
spec = create_spec(spec_dict)
|
|
|
|
Request
|
|
*******
|
|
|
|
Now you can use it to validate requests
|
|
|
|
.. code-block:: python
|
|
|
|
from openapi_core.validation.request.validators import RequestValidator
|
|
|
|
validator = RequestValidator(spec)
|
|
result = validator.validate(request)
|
|
|
|
# raise errors if request invalid
|
|
result.raise_for_errors()
|
|
|
|
# get list of errors
|
|
errors = result.errors
|
|
|
|
and unmarshal request data from validation result
|
|
|
|
.. code-block:: python
|
|
|
|
# get parameters object with path, query, cookies and headers parameters
|
|
validated_params = result.parameters
|
|
# or specific parameters
|
|
validated_path_params = result.parameters.path
|
|
|
|
# get body
|
|
validated_body = result.body
|
|
|
|
# get security data
|
|
validated_security = result.security
|
|
|
|
Request object should be instance of OpenAPIRequest class (See `Integrations <https://openapi-core.readthedocs.io/en/latest/integrations.html>`__).
|
|
|
|
Response
|
|
********
|
|
|
|
You can also validate responses
|
|
|
|
.. code-block:: python
|
|
|
|
from openapi_core.validation.response.validators import ResponseValidator
|
|
|
|
validator = ResponseValidator(spec)
|
|
result = validator.validate(request, response)
|
|
|
|
# raise errors if response invalid
|
|
result.raise_for_errors()
|
|
|
|
# get list of errors
|
|
errors = result.errors
|
|
|
|
and unmarshal response data from validation result
|
|
|
|
.. code-block:: python
|
|
|
|
# get headers
|
|
validated_headers = result.headers
|
|
|
|
# get data
|
|
validated_data = result.data
|
|
|
|
Response object should be instance of OpenAPIResponse class (See `Integrations <https://openapi-core.readthedocs.io/en/latest/integrations.html>`__).
|
|
|
|
Related projects
|
|
################
|
|
* `openapi-spec-validator <https://github.com/p1c2u/openapi-spec-validator>`__
|
|
* `openapi-schema-validator <https://github.com/p1c2u/openapi-schema-validator>`__
|
|
* `pyramid_openapi3 <https://github.com/niteoweb/pyramid_openapi3>`__
|
|
* `tornado-openapi3 <https://github.com/correl/tornado-openapi3>`__
|