Skip to main content

No project description provided

Project description

# OpenAPI Spec validator

[![Package Version](https://img.shields.io/pypi/v/openapi-spec-validator.svg)](https://pypi.python.org/pypi/openapi-spec-validator)
[![Build Status](https://travis-ci.org/p1c2u/openapi-spec-validator.svg?branch=master)](https://travis-ci.org/p1c2u/openapi-spec-validator)
[![Code Coverage](https://img.shields.io/codecov/c/github/p1c2u/openapi-spec-validator/master.svg?style=flat)](https://codecov.io/github/p1c2u/openapi-spec-validator?branch=master)
[![PyPI Version](https://img.shields.io/pypi/pyversions/openapi-spec-validator.svg)](https://pypi.python.org/pypi/openapi-spec-validator)
[![PyPI Format](https://img.shields.io/pypi/format/openapi-spec-validator.svg)](https://pypi.python.org/pypi/openapi-spec-validator)
[![PyPI Status](https://img.shields.io/pypi/status/openapi-spec-validator.svg)](https://pypi.python.org/pypi/openapi-spec-validator)

## About

OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against the [OpenAPI 3.0.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) specification. The validator aims to check for full compliance with the Specification.

## Installation

$ pip install openapi-spec-validator

## Usage

Validate spec:

```python

from openapi_spec_validator import validate_spec

validate_spec(spec_dict)
```

Add `spec_url` to validate spec with relative files:

```python

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:

```python

from openapi_spec_validator import validate_spec_url

validate_spec_url('http://example.com/openapi.json')
```

If you want to iterate through validation errors:

```python

from openapi_spec_validator import openapi_v3_spec_validator

errors_iterator = openapi_v3_spec_validator.iter_errors(spec)
```

## 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.1.1.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

openapi_spec_validator-0.1.1-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file openapi-spec-validator-0.1.1.tar.gz.

File metadata

File hashes

Hashes for openapi-spec-validator-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d79e4cc96e108f8182d2dc1ed8b6d1e774b2aed156a1161bfc8ad1dcee4b9a73
MD5 ece823fd61571aa933393ea0646905e0
BLAKE2b-256 fa1f1e64ab981d25e4c170d508431f44c6b38bdb9adb690ef1eff228f92a0228

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_spec_validator-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 55ed21bb81398841af11ddd24e027f847adb30abd2add7a9ecacd8c6b21b4b93
MD5 5f147fae987c8efd915e0b52e464c271
BLAKE2b-256 e43dc95cdf51c643494cb4274633f0e8b7b4802a8ebdc6c77e0e494c209cf88f

See more details on using hashes here.

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