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 2.0 (aka Swagger)](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) and [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
### Command Line Interface
Straight forward way:
```bash
$ openapi-spec-validator some.yaml
```
or more pythonic way:
```bash
$ python -m openapi_spec_validator some.yaml
```
### Examples
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)
```
## Related projects
* [openapi-core](https://github.com/p1c2u/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
[![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 2.0 (aka Swagger)](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) and [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
### Command Line Interface
Straight forward way:
```bash
$ openapi-spec-validator some.yaml
```
or more pythonic way:
```bash
$ python -m openapi_spec_validator some.yaml
```
### Examples
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)
```
## Related projects
* [openapi-core](https://github.com/p1c2u/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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for openapi-spec-validator-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76fcd37c20d14f1a5084f41fb2e4d0d900f6474f5fda40c27ddbeb791eaad16e |
|
MD5 | 147cce54225b5329d2c8045c4d96741b |
|
BLAKE2b-256 | 0bb0226bee38ef344d053706486d5d734960654d1c9b5f11b2152919280187fa |
Close
Hashes for openapi_spec_validator-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f97ba93798cc958e04250ffe6418c7a25a13363c6cb0f0269d9e7db1a0e467c1 |
|
MD5 | 747618a215e4ab16cc20ef52c7bbd9ed |
|
BLAKE2b-256 | 86bfb22a27025a54a95c57a9199ab282e189735d76a21567976ecb73f2407d27 |