Redoc

Overview

Redoc node will render interactive API documentation from OpenAPI definitions. The node generates the document from an endpoint that points to an OpenAPI specification file.

Setup

Prerequisites

NA

Installation

To install the node from designer:

1. Go to Add more nodes option on the palette section.
   
2. Check for the Redoc node and click install.
   
3. Once installed, the designer is required to be restarted.
   

To install the node from CLI:

1. Go to your project workspace where you can see your package.json file.
   
2. Run the below give npm command.
   npm i @kumologica/kumologica-contrib-redoc

Technical Details

Properties

• Spec URL (Required)
  Provide the endpoint that host the OpenAPI spec. eg : http://petstore.swagger.io/v2/swagger.json

Supported Operations NA

Throws

None

Returns

Payload is overwritten by the response from this node. The node return an html content having Redoc based API documentation.