OpenAPI Spec Validator is a CLI, pre-commit hook and python package 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.
Check documentation to see more details about the features. All documentation is in the "docs" directory and online at openapi-spec-validator.readthedocs.io
pip install openapi-spec-validator
Alternatively 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_validatorCLI (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 pythonopenapi/openapi-spec-validator /openapi.yaml
or more pythonic way:
python -m openapi_spec_validator openapi.yaml
For more details, read about CLI (Command Line Interface).
repos: - repo: https://github.com/python-openapi/openapi-spec-validator rev: 0.8.0b1 # The version to use or 'master' for latest hooks: - id: openapi-spec-validator
For more details, read about pre-commit hook.
from openapi_spec_validator import validate 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(), the spec is valid. validate(spec_dict) validate({'openapi': '3.1.0'}) Traceback (most recent call last): ... OpenAPIValidationError: 'info' is a required property
For more details, read about Python package.
Copyright (c) 2017-2023, Artur Maciag, All rights reserved. Apache v2
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4