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)
```
## 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 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)
```
## 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.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f54ef5e1d24416b18aa858fa9c18fd50ff3a40f48cf5ceb18c2a0928c3d9e5f |
|
MD5 | b5ad895dec97d5ab66fe5c4161a85367 |
|
BLAKE2b-256 | aeb8ba75f272ff5fd49c6e4226c3d7efbb8f9b89def4c44b3d4da79f05412ff5 |
Close
Hashes for openapi_spec_validator-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0efe630544e3a2d9ba2109e301d176f92255d7d3864a47fc56305ef058cfc6b |
|
MD5 | 4f3e4301a4a7932ea9f8f8537afacc92 |
|
BLAKE2b-256 | aaec33240710c67b3dd3cf1282c0b96faf65b11a5cf4c4256a26c3da3b6356ae |