Skip to main content

Resolve and bundle openapi v3 specs.

Project description

OpenAPI Resolver

CircleCI CodeCov

This module recursively parses openapi specs resolving references.


Tests run locally via


Or via circleci-local

    circleci build 


The module has an embedded script that can be run via

    $ python -m openapi_resolver --help

    usage: [-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

Download files

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

Files for openapi-resolver, version 0.0.7rc2
Filename, size File type Python version Upload date Hashes
Filename, size openapi_resolver-0.0.7rc2.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page