python-openapi/openapi-spec-validatorPublic

NotificationsYou must be signed in to change notification settings
Fork68
Star379

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.

License

Apache-2.0 license

379 stars 68 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
openapi_spec_validator		openapi_spec_validator
tests/integration		tests/integration
.gitignore		.gitignore
.travis.yml		.travis.yml
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
README.md		README.md
requirements.txt		requirements.txt
requirements_dev.txt		requirements_dev.txt
setup.py		setup.py
tox.ini		tox.ini

Repository files navigation

OpenAPI Spec validator

About

OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against theOpenAPI 3.0.0 specification. The validator aims to check for full compliance with the Specification.

Installation

$ pip install openapi-spec-validator

Usage

Validate spec:

fromopenapi_spec_validatorimportvalidate_specvalidate_spec(spec)

You can also validate spec from url:

fromopenapi_spec_validatorimportvalidate_spec_urlvalidate_spec_url('http://example.com/openapi.json')

If you want to iterate through validation errors:

fromopenapi_spec_validatorimportopenapi_v3_spec_validatorerrors_iterator=openapi_v3_spec_validator.iter_errors(spec)

License

About

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.