# 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 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
[](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 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
1 maintainer
Metadata
1 maintainer
Release files for openapi-spec-validator 0.1.2
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.1.2.tar.gz | 12.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openapi_spec_validator-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.7 kB
Release files / openapi-spec-validator-0.1.2.tar.gz
| Download URL | openapi-spec-validator-0.1.2.tar.gz |
|---|---|
| Size | 12.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6f54ef5e1d24416b18aa858fa9c18fd50ff3a40f48cf5ceb18c2a0928c3d9e5f
|
|
BLAKE2b-256 checksum How to use checksums |
aeb8ba75f272ff5fd49c6e4226c3d7efbb8f9b89def4c44b3d4da79f05412ff5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / openapi_spec_validator-0.1.2-py3-none-any.whl
| Download URL | openapi_spec_validator-0.1.2-py3-none-any.whl |
|---|---|
| Size | 15.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c0efe630544e3a2d9ba2109e301d176f92255d7d3864a47fc56305ef058cfc6b
|
|
BLAKE2b-256 checksum How to use checksums |
aaec33240710c67b3dd3cf1282c0b96faf65b11a5cf4c4256a26c3da3b6356ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
