@grace-studio/openapi-docs

Installation

npm i -g @grace-studio/openapi-docs

# or

yarn global add @grace-studio/openapi-docs

Usage

Combines multiple JSON or YAML files to one OpenAPI file used for documentation. Outputs the files to /docs including the OpenAPI file and an html-file with a standalone reference to Redoc that can be used directly.

The html-file loads Redoc 3 (v3.x from the Redoc CDN) as an ES module and reads the spec from /openapi.yaml. Serve /docs from the root of a web server. Opening the file directly from disk does not work.

The command exits with code 1 if an input file is missing or is not .json, .yaml or .yml.

Merge multiple JSON or YAML files:

openapi-docs \
--files <input-files...>

Example:

openapi-docs \
-f ./testfiles/test.json ./testfiles/test2.json ./testfiles/test3.yml