Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

No project description provided

Project description

(This is a fork from https://github.com/p1c2u/openapi-spec-validator)

OpenAPI Spec validator

Package Version Build Status Code Coverage PyPI Version PyPI Format PyPI Status

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
stableforks_openapi_spec_validator-0.2.5-py3-none-any.whl (25.1 kB) Copy SHA256 hash SHA256 Wheel py3
stableforks-openapi-spec-validator-0.2.5.tar.gz (21.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page