openapi-reference-compiler

Compile an OpenAPI specification referencing local files into a single specification file

Installation

npm i openapi-reference-compiler

Features

• Compiles a main OpenAPI specification file that references other local files into a single OpenAPI JSON file
• Allows reference directories to be specified

Usage

It is suggested to use this utility invoked by an NPM script so that the OpenAPI documentation can be compiled into a single specification file at build time.

  Usage: refc [options]
 
  Merge OpenAPI definitions into a single file resolving references
 
 
  Options:
 
    -V, --version                  output the version number
    -i, --inputFile <inputFile>    main OpenAPI file
    -o, --outputFile <outputFile>  where output should be written
    -r, --refDirs <refDirs>        list of reference directories separated by ':'
    -t, --test                     just testing
    -h, --help                     output usage information

Example command line invocation:

./node_modules/.bin/refc 
     -i ./swagger-source/api.yaml
     -o ./swagger/api.json
     -r ./node_modules/common-errors/swagger

Example invocation via NPM:

In package.json, include:

"scripts": {
    "swagger": "refc -i ./swagger-source/api.yaml -o ./swagger/api.json -r ./node_modules/common-errors/swagger"
}

Then invoke using:

npm run swagger

Changelog

• 1.0.0: Initial release

License

Copyright (c) 2017 PointSource, LLC. MIT Licensed