colynn / multi-file-swagger-example

Multi-file Swagger example

Multi-file Swagger example

Example of how to split up a large Swagger spec into smaller files.

Read the blog post

Usage

Install the node tool:

  npm install -g multi-file-swagger

Run the command like so:

  multi-file-swagger index.yaml > index.json

This will resolve every json pointer ($ref) externally or internally and then save it in a json file. Which can then be used for code generation and so on.

You can also output as yaml by using the --output-format option

  multi-file-swagger -o yaml index.yaml > compiled.yaml

License

MIT