Openapi-core is a Python library that provides client-side and server-side support for the OpenAPI v3.0 and OpenAPI v3.1 and OpenAPI v3.2 specifications.
- Validation and unmarshalling of request and response data (including webhooks)
- Integration with popular libraries (Requests, Werkzeug) and frameworks (Django, Falcon, Flask, Starlette)
- Customization with media type deserializers and format unmarshallers
- Security data providers (API keys, Cookie, Basic, and Bearer HTTP authentications)
Check documentation to see more details about the features. All documentation is in the "docs" directory and online at openapi-core.readthedocs.io
Supported Integrations and it's versions:
| Integration | Version(s) | Level |
|---|---|---|
| AIOHTTP | versions 3.8+ and 3.11+ tracks | Low-level request and response classes |
| Django | versions 4, 5, and 6 | Middleware, decorator and low level |
| Falcon | version 4 | Middleware and low-level classes |
| FastAPI | versions 0.11x, 0.12x, and 0.13x | Middleware (low-level via Starlette integration) |
| Flask | versions 2 and 3 | View decorator, class-based view, and low-level classes |
| Requests | default dependency set | Low-level request, webhook request, and response classes |
| Starlette | versions 0.4x, 0.5x, and 1.x | Middleware and low-level classes |
| Werkzeug | default dependency set | Low-level request and response classes |
Recommended way (via pip):
pip install openapi-coreAlternatively you can download the code and install from the repository:
pip install -e git+https://github.com/python-openapi/openapi-core.git#egg=openapi_coreFirst, create your OpenAPI object.
fromopenapi_coreimportOpenAPIopenapi=OpenAPI.from_file_path('openapi.json')Now you can use it to validate and unmarshal against requests and/or responses.
# raises an error if the request is invalidresult=openapi.unmarshal_request(request)Retrieve validated and unmarshalled request data.
# get parameterspath_params=result.parameters.pathquery_params=result.parameters.querycookies_params=result.parameters.cookiesheaders_params=result.parameters.headers# get bodybody=result.body# get security datasecurity=result.securityThe request object should implement the OpenAPI Request protocol. Check Integrations to find officially supported implementations.
For more details read about the Unmarshalling process.
If you just want to validate your request/response data without unmarshalling, read about Validation instead.
- openapi-spec-validator : A Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger), OpenAPI 3.0, OpenAPI 3.1, and OpenAPI 3.2 specification. The validator aims to check for full compliance with the Specification.
- openapi-schema-validator : A Python library that validates schema against the OpenAPI Schema Specification v3.0, v3.1, and v3.2.
- bottle-openapi-3 : OpenAPI 3.0 Support for the Bottle Web Framework
- pyramid_openapi3 : Pyramid addon for OpenAPI3 validation of requests and responses.
- tornado-openapi3 : Tornado OpenAPI 3 request and response validation library.
The project is under the terms of the BSD 3-Clause License.