Swagger/OpenAPI 2.0 Parser
Project description
Prance
Swagger/OpenAPI 2.0 Parser for Python
Prances provices 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
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 referencesLargely, 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.txtDevelopment
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.1.3-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 602a58045da763f460709e546e7d52eb1002962e41f0c1113014b8d2a5f3aa4e |
|
| MD5 | 57843df826b8633aac5539f9904e8936 |
|
| BLAKE2b-256 | a3f810f81ed4810fba890f03a52cac362032d108e81ce718eb9bc16ab9c79bf2 |
