No project description provided
Project description
OpenAPI Spec validator
About
OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger) and OpenAPI 3.0.0 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:
$ openapi-spec-validator some.yaml
or more pythonic way:
$ python -m openapi_spec_validator some.yaml
Examples
Validate spec:
from openapi_spec_validator import validate_spec
validate_spec(spec_dict)
Add spec_url to validate spec with relative files:
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:
from openapi_spec_validator import validate_spec_url
validate_spec_url('http://example.com/openapi.json')
If you want to iterate through validation errors:
from openapi_spec_validator import openapi_v3_spec_validator
errors_iterator = openapi_v3_spec_validator.iter_errors(spec)
Related projects
- 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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openapi-spec-validator-0.2.7.tar.gz.
File metadata
- Download URL: openapi-spec-validator-0.2.7.tar.gz
- Upload date:
- Size: 22.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
77c4fb47fe8a7dd527c7433861638221eb416827dc1c5c983505c0a38ca6e9eb
|
|
| MD5 |
d9ca2f77244272a58c1481a5df20fa2b
|
|
| BLAKE2b-256 |
9d1e0738aead24566ea7c7df4830e4284fabeaf6ae89b7126245340cc9fa683a
|
File details
Details for the file openapi_spec_validator-0.2.7-py3-none-any.whl.
File metadata
- Download URL: openapi_spec_validator-0.2.7-py3-none-any.whl
- Upload date:
- Size: 24.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
873aad19e68c8eeceb9922840f39e671e8ce62b2587f18b4f66f306d9eed8bd9
|
|
| MD5 |
e7b1c160f4147a51684e13c6d5975b16
|
|
| BLAKE2b-256 |
34986bf2cbbc6633768f0a23baefa8e1c7be4bf4aeb800d3ee82fd0ccbb2dc7d
|
File details
Details for the file openapi_spec_validator-0.2.7-py2-none-any.whl.
File metadata
- Download URL: openapi_spec_validator-0.2.7-py2-none-any.whl
- Upload date:
- Size: 24.9 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.18.4 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d0f22167810c32e771fa7e4aab6ef26d09233b70817f4d84f9c13bd9a522a37
|
|
| MD5 |
fd8d9debccea50727eb7333c7aa3fc3e
|
|
| BLAKE2b-256 |
ff9ff9d17bc9c1f55ed869dea5a62764d006a3d5d6997414fbd47c86471aad50
|
