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_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
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(spec_dict)
validate_spec({'openapi': '3.1.0'})
Traceback (most recent call last):
...
OpenAPIValidationError: 'info' 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')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)License
Copyright (c) 2017-2022, Artur Maciag, All rights reserved. Apache v2
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openapi_spec_validator-0.5.5.tar.gz.
File metadata
- Download URL: openapi_spec_validator-0.5.5.tar.gz
- Upload date:
- Size: 28.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.3.2 CPython/3.11.1 Linux/5.15.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3010df5237748e25d7fac2b2aaf13457c1afd02735b2bd6f008a10079c8f443a
|
|
| MD5 |
65f4815ed69c2418bab1104caaccd70a
|
|
| BLAKE2b-256 |
5bd85a291b895e79bdab621398a66cbd1af27ed957c016b7f8b0667fbf62569f
|
File details
Details for the file openapi_spec_validator-0.5.5-py3-none-any.whl.
File metadata
- Download URL: openapi_spec_validator-0.5.5-py3-none-any.whl
- Upload date:
- Size: 32.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.3.2 CPython/3.11.1 Linux/5.15.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
93ba247f585e1447214b4207728a7cce3726d148238217be69e6b8725c118fbe
|
|
| MD5 |
9d228f1552617d888ae9aa2b536e1924
|
|
| BLAKE2b-256 |
2fd0a9bb1909fe66ebf700931b6542cef46707342086390930117a1289a4530c
|
