# OpenAPI Spec validator
[](https://pypi.python.org/pypi/openapi-spec-validator)
[](https://travis-ci.org/p1c2u/openapi-spec-validator)
[](https://codecov.io/github/p1c2u/openapi-spec-validator?branch=master)
[](https://pypi.python.org/pypi/openapi-spec-validator)
[](https://pypi.python.org/pypi/openapi-spec-validator)
[](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
[](https://pypi.python.org/pypi/openapi-spec-validator)
[](https://travis-ci.org/p1c2u/openapi-spec-validator)
[](https://codecov.io/github/p1c2u/openapi-spec-validator?branch=master)
[](https://pypi.python.org/pypi/openapi-spec-validator)
[](https://pypi.python.org/pypi/openapi-spec-validator)
[](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
1 maintainer
Metadata
1 maintainer
Release files for openapi-spec-validator 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openapi-spec-validator-0.2.3.tar.gz | 16.6 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openapi_spec_validator-0.2.3-py3-none-any.whl | Python 3 | none | any | Details |
| openapi_spec_validator-0.2.3-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 59.3 kB
Release files / openapi-spec-validator-0.2.3.tar.gz
| Download URL | openapi-spec-validator-0.2.3.tar.gz |
|---|---|
| Size | 16.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
80e7241d768c9e70f4110afd956e69cfdf48854e2d90bc5f4544b30d4b088b9f
|
|
BLAKE2b-256 checksum How to use checksums |
f18ae392405a41e2799c6d9bc18351dcb6ba94fdcb22e3175b014039242722cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / openapi_spec_validator-0.2.3-py3-none-any.whl
| Download URL | openapi_spec_validator-0.2.3-py3-none-any.whl |
|---|---|
| Size | 22.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b8c53176bea053de393214eb17183eb68c7c759c31ec6cad71ddb203e3855a63
|
|
BLAKE2b-256 checksum How to use checksums |
4d5b0c64bc63e8a3ac0271fc181fb3a0e5555a2a9a3c6dbc67f070e4a1067760
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / openapi_spec_validator-0.2.3-py2-none-any.whl
| Download URL | openapi_spec_validator-0.2.3-py2-none-any.whl |
|---|---|
| Size | 20.4 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
5335222e039500ab5dea471fcabf0adddb7bafc4bf13a44d2282f83545465f51
|
|
BLAKE2b-256 checksum How to use checksums |
08a2a820ea09c85cf73da2558f08770664093395d45c34d57954ed19eae07a34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
