client-side and server-side support for the OpenAPI Specification v3
Project description
About
Openapi-core is a Python library that adds client-side and server-side support for the OpenAPI v3.0 and OpenAPI v3.1 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
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_core
Usage
Firstly create your specification object.
from openapi_core import Spec
spec = Spec.from_file_path('openapi.json')
Now you can use it to validate against requests and/or responses.
Request
Use validate_request function to validate request against a given spec.
from openapi_core import validate_request
# raise error if request is invalid
result = validate_request(request, spec=spec)
Request object should implement OpenAPI Request protocol (See Integrations).
(For OpenAPI v3.1) Use the same function to validate webhook request against a given spec.
# raise error if request is invalid
result = validate_request(webhook_request, spec=spec)
Webhook request object should implement OpenAPI WebhookRequest protocol (See Integrations).
Retrieve 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.security
Response
Use validate_response function to validate response against a given spec.
from openapi_core import validate_response
# raise error if response is invalid
result = validate_response(request, response, spec=spec)
Response object should implement OpenAPI Response protocol (See Integrations).
(For OpenAPI v3.1) Use the same function to validate response from webhook request against a given spec.
# raise error if request is invalid
result = validate_response(webhook_request, response, spec=spec)
Retrieve response data from validation result
# get headers
validated_headers = result.headers
# get data
validated_data = result.data
In order to explicitly validate a:
OpenAPI 3.0 spec, import V30RequestValidator or V30ResponseValidator
OpenAPI 3.1 spec, import V31RequestValidator or V31ResponseValidator or V31WebhookRequestValidator or V31WebhookResponseValidator
from openapi_core import V31ResponseValidator
result = validate_response(request, response, spec=spec, cls=V31ResponseValidator)
You can also explicitly import V3RequestValidator or V3ResponseValidator which is a shortcut to the latest v3 release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openapi_core-0.17.0a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe17c86b828c608bab4a802a62052a8792dd54ba354f9fc7796efebda19c59a4 |
|
MD5 | 79302a21f443da0a96e507f1d38776a1 |
|
BLAKE2b-256 | f911030b3948217eabffbf334a1956938501948a65d42bff43ff4705dcb896c9 |