Swagger/OpenAPI 2.0 Parser
Project description
Prance provides parsers for Swagger/OpenAPI 2.0 API specifications in Python. It uses swagger_spec_validator to validate specifications, but additionally resolves JSON references in accordance with the Swagger spec.
Mostly the latter involves handling non-URI references; Swagger is fine with providing relative file paths, whereas JSON references require URIs at this point in time.
Usage
Command Line Interface
After installing prance, a CLI is available for validating (and resolving external references in) specs:
# Validates with resolving
$ prance validate path/to/swagger.yml
# Validates without resolving
$ prance validate --no-resolve path/to/swagger.yml
# Validates and resolves, and writes the results to output.yaml
$ prance validate -o output.yaml path/to/swagger.yml
# Fetch URL, validate and resolve.
$ prance validate http://petstore.swagger.io/v2/swagger.json
Processing "http://petstore.swagger.io/v2/swagger.json"...
-> Resolving external references.
Validates OK as Swagger/OpenAPI 2.0!Code
Most likely you have spec file and want to parse it:
from prance import ResolvingParser
parser = ResolvingParser('path/to/my/swagger.yaml')
parser.specification # contains fully resolved specs as a dictPrance also includes a non-resolving parser that does not follow JSON references, in case you prefer that.
from prance import BaseParser
parser = BaseParser('path/to/my/swagger.yaml')
parser.specification # contains specs as a dict still containing JSON referencesURLs can also be parsed:
parser = ResolvingParser('http://petstore.swagger.io/v2/swagger.json')Largely, that’s it. There is a whole slew of utility code that you may or may not find useful, too. Look at the full documentation for details.
Setup
Use virtualenv to create a virtual environment and change to it or not, as you see fit.
Then install the requirements:
$ pip install -r requirements.txtDocumentation
After setup, run the following to generate documentation:
$ python setup.py build_sphinxDevelopment
Test Execution
Run the whole test suite:
$ python setup.py testRun a single test scenario:
$ pytest tests/test_resolving_parser.py::test_basicsRun tests on multiple Python versions:
$ toxRun tests on Python 2.7:
$ tox -e py27A simple test coverage report is automatically generated.
License
Licensed under MITNFA (MIT +no-false-attribs) License. See the LICENSE.txt file for 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
Hashes for prance-0.5.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 20c944f13a409a182308ef4ca62d1b00ee8b28a34fd08ce4dc96addac7dbf6d1 |
|
| MD5 | a0b4128b94bfc13bcc6987219a6f0291 |
|
| BLAKE2b-256 | 8bcc05999aed0a6fd00e5bf22d60cdfd20faa84caf82d62f236bc59793817f32 |
