Metadata-Version: 2.1
Name: openapi-core
Version: 0.5.0
Summary: UNKNOWN
Home-page: https://github.com/p1c2u/openapi-core
Author: Artur Maciąg
Author-email: maciag.artur@gmail.com
License: UNKNOWN
Description: 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.0.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md>`__.
        
        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)
        
        Now you can use it to validate requests
        
        .. code-block:: python
        
           from openapi_core.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 dictionary with path, query, cookies and headers parameters
           validated_params = result.parameters
        
           # get body
           validated_body = result.body
        
        or use shortcuts for simple validation
        
        .. code-block:: python
        
           from openapi_core import validate_parameters, validate_body
        
           validated_params = validate_parameters(spec, request)
           validated_body = validate_body(spec, request)
        
        Request object should implement BaseOpenAPIRequest interface. You can use FlaskOpenAPIRequest a Flask/Werkzeug request wrapper implementation:
        
        .. code-block:: python
        
           from openapi_core.validators import RequestValidator
           from openapi_core.wrappers import FlaskOpenAPIRequest
        
           openapi_request = FlaskOpenAPIRequest(flask_request)
           validator = RequestValidator(spec)
           result = validator.validate(openapi_request)
        
        or specify request wrapper class for shortcuts
        
        .. code-block:: python
        
           from openapi_core import validate_parameters, validate_body
        
           validated_params = validate_parameters(
               spec, request, wrapper_class=FlaskOpenAPIRequest)
           validated_body = validate_body(
               spec, request, wrapper_class=FlaskOpenAPIRequest)
        
        You can also validate responses
        
        .. code-block:: python
        
           from openapi_core.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
        
        or use shortcuts for simple validation
        
        .. code-block:: python
        
           from openapi_core import validate_data
        
           validated_data = validate_data(spec, request, response)
        
        Response object should implement BaseOpenAPIResponse interface. You can use FlaskOpenAPIResponse a Flask/Werkzeug response wrapper implementation:
        
        .. code-block:: python
        
           from openapi_core.validators import ResponseValidator
           from openapi_core.wrappers import FlaskOpenAPIResponse
        
           openapi_response = FlaskOpenAPIResponse(flask_response)
           validator = ResponseValidator(spec)
           result = validator.validate(openapi_request, openapi_response)
        
        or specify response wrapper class for shortcuts
        
        .. code-block:: python
        
           from openapi_core import validate_parameters, validate_body
        
           validated_data = validate_data(
               spec, request, response, response_wrapper_class=FlaskOpenAPIResponse)
        
        Related projects
        ================
        * `openapi-spec-validator <https://github.com/p1c2u/openapi-spec-validator>`__
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries
Provides-Extra: flask
