openapi-core 0.17.0a1

client-side and server-side support for the OpenAPI Specification v3

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.

Related projects

• bottle-openapi-3

  OpenAPI 3.0 Support for the Bottle Web Framework

• openapi-spec-validator

  Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger) and OpenAPI 3.0 specification

• openapi-schema-validator

  Python library that validates schema against the OpenAPI Schema Specification v3.0.

• pyramid_openapi3

  Pyramid addon for OpenAPI3 validation of requests and responses.

• tornado-openapi3

  Tornado OpenAPI 3 request and response validation library.