OpenAPI 2.0 (aka Swagger) and OpenAPI 3.0 spec validator
Project description
About
OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger) and OpenAPI 3.0 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 syntax is expected. To validate an OpenAPI v3 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. You can also explicitly import validate_v3_spec if you want to disambiguate the expected version.
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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97f258850afc97b048f7c2653855e0f88fa66ac103c2be5077c7960aca2ad49a |
|
MD5 | 815a14cd28a855c4c3021c1829106024 |
|
BLAKE2b-256 | 3741199441b0ae1f9522ce511fd65cbcd9e8634aed733bd0ab2a9235fe29dec6 |
Hashes for openapi_spec_validator-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06900ac4d546a1df3642a779da0055be58869c598e3042a2fef067cfd99d04d0 |
|
MD5 | 12dc49079c03a91d00ebe189c01b7817 |
|
BLAKE2b-256 | 36c919eb75423082fdbf9c11ed66ab6f038d245023487ce9720b9ced9efcf57e |