Openapi-core is a Python library that adds client-side and server-side support for the OpenAPI Specification v3.
- 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
Check documentation to see more details about the features. All documentation is in the "docs" directory and online at openapi-core.readthedocs.io
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_coreFirstly 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.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.errorsand unmarshal request data from validation result
# 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.securityRequest object should be instance of OpenAPIRequest class (See Integrations).
You can also validate responses
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.errorsand unmarshal response data from validation result
# get headers
validated_headers = result.headers
# get data
validated_data = result.dataResponse object should be instance of OpenAPIResponse class (See Integrations).