No project description provided
Project description
(This is a fork from https://github.com/p1c2u/openapi-spec-validator)
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
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 stableforks-openapi-spec-validator-0.2.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5788ccab1d27305ef00324feb07cca5d749c63151dc21e2bb661006ae63b27b6 |
|
MD5 | dc768f8bcbf554114e7d9cdfa98e68ad |
|
BLAKE2b-256 | 0d491629eb9086ebeda3ec8953966f56987062a2643fc74244f6e2c3d8204e7a |
Close
Hashes for stableforks_openapi_spec_validator-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da6b13bcd19e8c554907f03a4405dadaa36b58731504c8d10ca253e5dbc1af95 |
|
MD5 | 86770667ce8f35784c538d911f8b8bb0 |
|
BLAKE2b-256 | d9e3a7a79dba7ddf70c381e80fb0033991550cb0e6e2c95e510d2e4d6bdc856c |