Skip to main content

OpenAPI 2.0 (aka Swagger) and OpenAPI 3 spec validator

Project description


OpenAPI Spec Validator is 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.


$ pip install openapi-spec-validator

Alternatively you can download the code and install from the repository:

$ pip install -e git+


Command Line Interface

Straight forward way:

$ openapi-spec-validator openapi.yaml

pipes way:

$ cat openapi.yaml | openapi-spec-validator -

docker way:

$ docker run -v path/to/openapi.yaml:/openapi.yaml --rm p1c2u/openapi-spec-validator /openapi.yaml

or more pythonic way:

$ python -m openapi_spec_validator openapi.yaml


By default, OpenAPI spec version is detected. To validate spec:

from openapi_spec_validator import validate_spec
from openapi_spec_validator.readers import read_from_filename

spec_dict, spec_url = read_from_filename('openapi.yaml')

# If no exception is raised by validate_spec(), the spec is valid.

validate_spec({'openapi': '3.1.0'})

Traceback (most recent call last):
OpenAPIValidationError: 'info' is a required property

Add spec_url to validate spec with relative files:

validate_spec(spec_dict, spec_url='file:///path/to/spec/openapi.yaml')

You can also validate spec from url:

from openapi_spec_validator import validate_spec_url

# If no exception is raised by validate_spec_url(), the spec is valid.

In order to explicitly validate a:

  • Swagger / OpenAPI 2.0 spec, import openapi_v2_spec_validator

  • OpenAPI 3.0 spec, import openapi_v30_spec_validator

  • OpenAPI 3.1 spec, import openapi_v31_spec_validator

and pass the validator to validate_spec or validate_spec_url function:

validate_spec(spec_dict, validator=openapi_v31_spec_validator)

You can also explicitly import openapi_v3_spec_validator which is a shortcut to the latest v3 release.

If you want to iterate through validation errors:

from openapi_spec_validator import openapi_v3_spec_validator

errors_iterator = openapi_v3_spec_validator.iter_errors(spec)


Copyright (c) 2017-2022, Artur Maciag, All rights reserved. Apache v2

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi-spec-validator-0.5.1.tar.gz (27.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page