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

https://img.shields.io/pypi/pyversions/openapi-spec-validator.svg

https://img.shields.io/pypi/format/openapi-spec-validator.svg

https://img.shields.io/pypi/status/openapi-spec-validator.svg

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-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 p1c2u/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).

Python package

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 property

For more details, read about Python package.

License

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi_spec_validator-0.5.7.tar.gz (33.7 kB view details)

Uploaded Jun 11, 2023 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

openapi_spec_validator-0.5.7-py3-none-any.whl (32.4 kB view details)

Uploaded Jun 11, 2023 Python 3

File details

Details for the file openapi_spec_validator-0.5.7.tar.gz.

File metadata

Download URL: openapi_spec_validator-0.5.7.tar.gz
Upload date: Jun 11, 2023
Size: 33.7 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.5.1 CPython/3.11.3 Linux/5.15.0-1038-azure

File hashes

Hashes for openapi_spec_validator-0.5.7.tar.gz
Algorithm	Hash digest
SHA256	`6c2d42180045a80fd6314de848b94310bdb0fa4949f4b099578b69f79d9fa5ac`
MD5	`6c10f96f4f02b84205dfc34a8e73a62b`
BLAKE2b-256	`27e59fe67dfd403777d500abb5cd650c16ef9d4918a6c12e87731c3a4feeb4ff`

See more details on using hashes here.

File details

Details for the file openapi_spec_validator-0.5.7-py3-none-any.whl.

File metadata

Download URL: openapi_spec_validator-0.5.7-py3-none-any.whl
Upload date: Jun 11, 2023
Size: 32.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.5.1 CPython/3.11.3 Linux/5.15.0-1038-azure

File hashes

Hashes for openapi_spec_validator-0.5.7-py3-none-any.whl
Algorithm	Hash digest
SHA256	`8712d2879db7692974ef89c47a3ebfc79436442921ec3a826ac0ce80cde8c549`
MD5	`7ca6099f95bc5178cd7e48d9edf42ba1`
BLAKE2b-256	`a86805df6b11a082ee09b8b5319b3c8aeda58b8d3bccf89f201c45e8fe8a91d2`