openapi-core
About
Openapi-core is a Python library that adds client-side and server-side support for the OpenAPI Specification v3.0.0.
Installation
Recommended way (via pip):
$ pip install openapi-core
Alternatively you can download the code and install from the repository:
$ pip install -e git+https://github.com/p1c2u/openapi-core.git#egg=openapi_coreUsage
Firstly create your specification:
from openapi_core import create_spec
spec = create_spec(spec_dict)Now you can use it to validate requests
from openapi_core.shortcuts import RequestValidator
validator = RequestValidator(spec)
result = validator.validate(request)
# raise errors if request invalid
result.raise_for_errors()
# get list of errors
errors = result.errorsand unmarshal request data from validation result
# get parameters dictionary with path, query, cookies and headers parameters
validated_params = result.parameters
# get body
validated_body = result.bodyor use shortcuts for simple validation
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:
from openapi_core.shortcuts import RequestValidator
from openapi_core.wrappers.flask import FlaskOpenAPIRequest
openapi_request = FlaskOpenAPIRequest(flask_request)
validator = RequestValidator(spec)
result = validator.validate(openapi_request)or specify request wrapper class for shortcuts
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
from openapi_core.shortcuts 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.errorsand unmarshal response data from validation result
# get headers
validated_headers = result.headers
# get data
validated_data = result.dataor use shortcuts for simple validation
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:
from openapi_core.shortcuts import ResponseValidator
from openapi_core.wrappers.flask import FlaskOpenAPIResponse
openapi_response = FlaskOpenAPIResponse(flask_response)
validator = ResponseValidator(spec)
result = validator.validate(openapi_request, openapi_response)or specify response wrapper class for shortcuts
from openapi_core import validate_parameters, validate_body
validated_data = validate_data(
spec, request, response, response_wrapper_class=FlaskOpenAPIResponse)