Skip to content
/ oas3 Public

Python Library for the Open API Specification v3

License

Notifications You must be signed in to change notification settings

pinntech/oas3

Repository files navigation

OAS3

travis-ci coveralls pypi license

OAS3 is a parser, validator and compiler for dealing with Open API Specification v3. This library provides an interface for working with specifications, and loading and dumping to various locations and formats.

Quickstart

To get started load your spec, it will be validated upon dumping.

from oas3 import Spec

# Load the Spec from a file
spec = Spec.from_file('./spec.json')
spec = Spec.from_file('./spec.yml')

# Load the Spec from a URL
spec = Spec.from_url('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml')

# Load the Spec from a python native dictionary
spec = Spec.from_dict(spec_dict)

# A spec that is sufficiently loaded (i.e. valid OAS3) can now be dumped
spec.to_file('/tmp/spec.yaml')
spec.to_dict()
spec.to_json()
spec.to_yaml()

About

Python Library for the Open API Specification v3

Resources

License

Stars

Watchers

Forks

Packages

No packages published