Resolve and bundle openapi v3 specs.
Project description
OpenAPI Resolver
This module recursively parses openapi specs resolving references.
Test
Tests run locally via
tox
Or via circleci-local
circleci build
Usage
The module has an embedded script that can be run via
$ python -m openapi_resolver --help
usage: __main__.py [-h] src_file [dst_file]
Recursively resolves and bundles OpenAPI v3 files.
positional arguments:
src_file An OpenAPI v3 yaml file.
dst_file Destination file, default is stdout.
optional arguments:
-h, --help show this help message and exit
To create an openapi bundle from a spec file just run
$ python -m openapi_resolver sample.yaml
You can use this module to normalize two specs before diffing, eg:
$ python -m openapi_resolver one.yaml normal-one.yaml
$ python -m openapi_resolver two.yaml normal-two.yaml
$ diff normal-one.yaml normal-two.yaml
Use with docker
Build the image with:
$ docker build --tag openapi-resolver .
then run docker mapping the openapi.yaml directory
to the /code
volume.
docker run -it --rm -v $(dirname path-to-openapi.yaml):/code \
openapi-resolver /code/openapi.yaml /code/bundle.yaml
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
Close
Hashes for openapi_resolver-0.0.7rc2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 385fceed0cc3e411fb75af40adfd91fb8cd20f79f2be7f1214b235ca08991b1c |
|
MD5 | 0e9e3284abb0074906c345ad71c8a4e3 |
|
BLAKE2b-256 | 78c38b5b5d245267176132cfd9939a6d03180d2de281d0363c3e455505dd32c0 |