Skip to main content

No project description provided

Project description

# OpenAPI Spec validator

[![Package Version](](
[![Build Status](](
[![Code Coverage](](
[![PyPI Version](](
[![PyPI Format](](
[![PyPI Status](](

## About

OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against the [OpenAPI 2.0 (aka Swagger)]( and [OpenAPI 3.0.0]( specification. The validator aims to check for full compliance with the Specification.

## Installation

$ pip install openapi-spec-validator

## Usage

### Command Line Interface

Straight forward way:

$ openapi-spec-validator some.yaml

or more pythonic way:

$ python -m openapi_spec_validator some.yaml

### Examples

Validate spec:


from openapi_spec_validator import validate_spec


Add `spec_url` to validate spec with relative files:


from openapi_spec_validator import validate_spec

validate_spec(spec_dict, spec_url='file:///path/to/spec/openapi.yaml')

You can also validate spec from url:


from openapi_spec_validator import validate_spec_url


If you want to iterate through validation errors:


from openapi_spec_validator import openapi_v3_spec_validator

errors_iterator = openapi_v3_spec_validator.iter_errors(spec)

## Related projects

* [openapi-core]( is a Python library that adds client-side and server-side support for the OpenAPI.

## License

Copyright (c) 2017, Artur Maciag, All rights reserved.
Apache v2

Project details

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.2.1.tar.gz (17.2 kB view hashes)

Uploaded Source

Built Distributions

openapi_spec_validator-0.2.1-py3-none-any.whl (21.0 kB view hashes)

Uploaded Python 3

openapi_spec_validator-0.2.1-py2-none-any.whl (21.1 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page