Repository files navigation

Openapi-core is a Python library that provides client-side and server-side supportfor theOpenAPI v3.0andOpenAPI v3.1 specifications.

• Validation andunmarshalling of request and response data (including webhooks)
• Integration with popular libraries (Requests, Werkzeug) and frameworks (Django, Falcon, Flask, Starlette)
• Customization with media typedeserializers and formatunmarshallers
• 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 atopenapi-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/python-openapi/openapi-core.git#egg=openapi_core

First, 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.security

The request object should implement the OpenAPI Request protocol. CheckIntegrations to find officially supported implementations.

For more details read about theUnmarshalling process.

If you just want to validate your request/response data without unmarshalling, read aboutValidation instead.

• openapi-spec-validator: A Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger), OpenAPI 3.0, and OpenAPI 3.1 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 and OpenAPI Schema Specification v3.1.
• 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.