Redocly

Lifeboat has the ability to install Redocly, an open source tool for generating HTML documentation from OpenAPI (formerly Swagger) definitions. Once installed, Lifeboat offers an easy to use interface for "compiling" OpenAPI documents to HTML.

Installation

When the tool item is selected in Lifeboat a version check is performed on the server. If Redocly is not found but the server is capable of installation, the "Install Redocly" button becomes available.

Click "Install Redocly" to install the necessary components. This will take several minutes.

Usage

Below the status box is a file input control. Drag in or select a .json or .yaml OpenAPI spec document. When there is a source file in this control the "Compile HTML" button becomes available.

The "Include Download Button" checkbox can hide the "Download specification" button from the compiled HTML file. The authors would like to note that "hiding the download button does not protect your information in any way."

Click "Compile HTML" to upload the OpenAPI document in the file control and compile it with Redocly. A Save dialog will ask for a place to write the compiled HTML. Selecting a save destination will initiate the upload, compile, download process. Lifeboat will be unavailable during this time.

When the "Compile HTML" button is greyed out (disabled) it means that there is no OpenAPI document to compile in the file input control at the top.