OpenAPI 2.0 (aka Swagger) and OpenAPI 3 spec validator
Project description
About
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.
Installation
$ pip install openapi-spec-validator
Alternatively you can download the code and install from the repository:
$ pip install -e git+https://github.com/p1c2u/openapi-spec-validator.git#egg=openapi_spec_validator
Usage
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
Examples
By default, OpenAPI v3.1 syntax is expected. To validate an OpenAPI v3.1 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(spec_dict)
validate_spec({})
Traceback (most recent call last):
...
OpenAPIValidationError: 'openapi' is a required property
In order to validate a Swagger / OpenAPI 2.0 spec file, import validate_v2_spec instead of validate_spec. In order to validate a OpenAPI 3.0 spec file, import validate_v30_spec instead of validate_spec.
You can also explicitly import validate_v31_spec if you want to disambiguate the expected version or explicitly import validate_v3_spec which is a shortcut to the latest v3 release.
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.
validate_spec_url('http://example.com/openapi.json')
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)
License
Copyright (c) 2017-2021, Artur Maciag, All rights reserved. Apache v2
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-spec-validator-0.5.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 780714eb30452e9c5e663d4ed4bbe89f7119c3811f74de9993993b79e07963c6 |
|
MD5 | f7c9a7e7685801618582212e9ced6e9b |
|
BLAKE2b-256 | 8fa6db9fcad00a18fdbbef36e7058d6af6eae98d4997e0eec491aaee3e19825f |
Hashes for openapi_spec_validator-0.5.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16325b019dc79edf30cd25ecc2ec4b9176bea31fa2ce8da11b3cf41cc98198e9 |
|
MD5 | 789136fdb28bdfaf242b739539fc1828 |
|
BLAKE2b-256 | b9c040496e5ba7102649a0a97d97958f78f9ce89cb9e7b4744ea3bd75a541d33 |