Skip to main content

Resolve and bundle openapi v3 specs.

Project description

OpenAPI Resolver

CircleCI

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

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.6
Filename, size File type Python version Upload date Hashes
Filename, size openapi_resolver-0.0.6.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page