python-openapi/openapi-spec-validatorPublic

NotificationsYou must be signed in to change notification settings
Fork70
Star358

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

358 stars 70 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 571 Commits
.github		.github
docs		docs
openapi_spec_validator		openapi_spec_validator
tests/integration		tests/integration
.bumpversion.cfg		.bumpversion.cfg
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.pre-commit-hooks.yaml		.pre-commit-hooks.yaml
.readthedocs.yaml		.readthedocs.yaml
.travis.yml		.travis.yml
CONTRIBUTING.rst		CONTRIBUTING.rst
Dockerfile		Dockerfile
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
NOTICE		NOTICE
README.rst		README.rst
SECURITY.md		SECURITY.md
hooks.yaml		hooks.yaml
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
tox.ini		tox.ini

Repository files navigation

OpenAPI Spec validator

https://travis-ci.org/python-openapi/openapi-spec-validator.svg?branch=master

https://img.shields.io/codecov/c/github/python-openapi/openapi-spec-validator/master.svg?style=flat

About

OpenAPI Spec Validator is a CLI, pre-commit hook and python package that validates OpenAPI Specsagainst theOpenAPI 2.0 (aka Swagger),OpenAPI 3.0andOpenAPI 3.1specification. 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 atopenapi-spec-validator.readthedocs.io

Installation

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_validator

Usage

CLI (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 aboutCLI (Command Line Interface).

pre-commit hook

repos:-repo:https://github.com/python-openapi/openapi-spec-validatorrev:0.5.5# The version to use or 'master' for latesthooks:    -id:openapi-spec-validator

For more details, read aboutpre-commit hook.

Python package

fromopenapi_spec_validatorimportvalidatefromopenapi_spec_validator.readersimportread_from_filenamespec_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 (mostrecentcalllast):    ...OpenAPIValidationError:'info'isarequiredproperty

For more details, read aboutPython package.

Related projects

openapi-core
Python library that adds client-side and server-side support for the OpenAPI v3.0 and OpenAPI v3.1 specification.
openapi-schema-validator
Python library that validates schema against the OpenAPI Schema Specification v3.0 and OpenAPI Schema Specification v3.1.

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.