OpenAPI Spec validator
About
OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger) and OpenAPI 3.0.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_validatorUsage
Command Line Interface
Straight forward way:
$ openapi-spec-validator openapi.yamlpipes way:
$ cat openapi.yaml | openapi-spec-validator -docker way:
$ docker run -v path/to/openapi.yaml:/openapi.yaml --rm p1c2u/openapi-spec-validator /openapi.yamlor more pythonic way:
$ python -m openapi_spec_validator openapi.yamlExamples
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(spec_dict)
validate_spec({})
Traceback (most recent call last):
...
OpenAPIValidationError: 'openapi' is a required propertyAdd 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
1 maintainer
Metadata
1 maintainer
Release files for openapi-spec-validator 0.2.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| openapi-spec-validator-0.2.10.tar.gz | 24.1 kB | Without provenance | Details for openapi-spec-validator-0.2.10.tar.gz |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| openapi_spec_validator-0.2.10-py3-none-any.whl | Python 3 | none | any | Details for openapi_spec_validator-0.2.10-py3-none-any.whl |
| openapi_spec_validator-0.2.10-py2-none-any.whl | Python 2 | none | any | Details for openapi_spec_validator-0.2.10-py2-none-any.whl |
Total release size: 81.1 kB
Release files / openapi-spec-validator-0.2.10.tar.gz
| Download URL | openapi-spec-validator-0.2.10.tar.gz |
|---|---|
| Size | 24.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5dc0918ae5a125f2689e70477910db6a3d3eef60613ed6166adc55e91a85e09c
|
|
BLAKE2b-256 checksum How to use checksums |
2259bc523bd2c9e80a70306da0cc0e9322700fd1cd6f7884be980ed179713e34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.6.13
|
Release files / openapi_spec_validator-0.2.10-py3-none-any.whl
| Download URL | openapi_spec_validator-0.2.10-py3-none-any.whl |
|---|---|
| Size | 28.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
518189ef0d925ef5cb5da55970dbde8c3f08b2de7ecefd5d5a2e44e282e226cf
|
|
BLAKE2b-256 checksum How to use checksums |
219074808eec7bd6fedb4e621fd4144cdbbc7ad87c8aaaf262e5d0cde4268eed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.6.13
|
Release files / openapi_spec_validator-0.2.10-py2-none-any.whl
| Download URL | openapi_spec_validator-0.2.10-py2-none-any.whl |
|---|---|
| Size | 28.5 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
11b1825933f4fa442be42f16b05ed5987f62639c7181c0ad827b16d33c9dea30
|
|
BLAKE2b-256 checksum How to use checksums |
8cd903fc99eff92ecc57f504f3d803a139108607e01ca47460d689d41ffb1a86
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.7.0 requests/2.25.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/2.7.18
|
Security for openapi-spec-validator 0.2.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
