Skip to content
This repository has been archived by the owner on Apr 24, 2020. It is now read-only.
/ openapi-bundle Public archive

Combine multiple json or yaml files into a single readable OpenAPI specification

License

Notifications You must be signed in to change notification settings

windtail/openapi-bundle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenAPI bundle

Combine multiple json or yaml files into a single readable OpenAPI specification.

Why bother ?

I am new to OpenAPI (swagger) . It's pain for me to write a very large yaml file, I follow the post to break the yaml into files.

"Most resolvers will resolve remote references first and the resolve local references." as it said in the post, but saddly json-refs gives me an error for local ref.

So I start a new tool and I believe local ref should be left untouched to improve readability.

Install

pip install openapi-bundle

Usage

Basically:

openapi-bundle /path/to/your/root/api/spec.yaml > /path/to/your/combined/api/spec.yaml

For other options, please run:

openapi-bundle --help

About

Combine multiple json or yaml files into a single readable OpenAPI specification

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages