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 Distributions
Close
Hashes for openapi-spec-validator-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80e7241d768c9e70f4110afd956e69cfdf48854e2d90bc5f4544b30d4b088b9f |
|
MD5 | da115c43c840e7b466c754756f82aa59 |
|
BLAKE2b-256 | f18ae392405a41e2799c6d9bc18351dcb6ba94fdcb22e3175b014039242722cf |
Close
Hashes for openapi_spec_validator-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8c53176bea053de393214eb17183eb68c7c759c31ec6cad71ddb203e3855a63 |
|
MD5 | 2a18ec6223fb16de5889537e35a51f77 |
|
BLAKE2b-256 | 4d5b0c64bc63e8a3ac0271fc181fb3a0e5555a2a9a3c6dbc67f070e4a1067760 |
Close
Hashes for openapi_spec_validator-0.2.3-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5335222e039500ab5dea471fcabf0adddb7bafc4bf13a44d2282f83545465f51 |
|
MD5 | 30e49740bb95d809bb5e0d32bec7b96e |
|
BLAKE2b-256 | 08a2a820ea09c85cf73da2558f08770664093395d45c34d57954ed19eae07a34 |