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.
Documentation
Check documentation to see more details about the features. All documentation is in the “docs” directory and online at openapi-spec-validator.readthedocs.io
Installation
pip install openapi-spec-validatorAlternatively you can download the code and install from the repository:
pip install -e git+https://github.com/python-openapi/openapi-spec-validator.git#egg=openapi_spec_validatorUsage
CLI (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.yamlFor more details, read about CLI (Command Line Interface).
Python package
from openapi_spec_validator import validate_spec
from openapi_spec_validator.readers import read_from_filename
spec_dict, base_uri = 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 propertyFor more details, read about Python package.
License
Copyright (c) 2017-2023, 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.6.0.tar.gz.
File metadata
- Download URL: openapi_spec_validator-0.6.0.tar.gz
- Upload date:
- Size: 33.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.5.1 CPython/3.11.4 Linux/5.15.0-1041-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
68c4c212c88ef14c6b1a591b895bf742c455783c7ebba2507abd7dbc1365a616
|
|
| MD5 |
6046702faf396a69a9d47245810c6008
|
|
| BLAKE2b-256 |
3f87733b5e5ccd80fc28046b3fbe559d54068094261d931a909e880c99bdcfe9
|
File details
Details for the file openapi_spec_validator-0.6.0-py3-none-any.whl.
File metadata
- Download URL: openapi_spec_validator-0.6.0-py3-none-any.whl
- Upload date:
- Size: 32.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.5.1 CPython/3.11.4 Linux/5.15.0-1041-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
675f1a3c0d0d8eff9116694acde88bcd4613a95bf5240270724d9d78c78f26d6
|
|
| MD5 |
af54fac48299645c2dcef33430e467bf
|
|
| BLAKE2b-256 |
2432c4272a50c125b225bedc730306e28aad9563ad85794c16de41c05b6135ca
|
