Octopus

A CLI to generate krakend endpoints

Install

With npm

npm i -g @fsteam/octopus-cli

With yarn

yarn global add @fsteam/octopus-cli

Overview

Commands:
  octo init     Generates yaml configuration file for the cli
  octo openapi  Generates api gateway endpoints from OpenApi Documentation

Usage

• Init

octo init

Generates octopus yaml configuration file

Options:
  -h, --help     Show help [boolean]
  -o, --output   Choose where to generate the endpoints [string]
  -c, --config   The krakend root configuration file [string]

• Openapi

octo openapi

Generates api gateway endpoints from OpenApi Documentation

Options:
  -h, --help     Show help [boolean]
  -u, --url      URL of the OpenApi Documentation [string]
  -f, --file     Yaml file of the OpenApi Documentation [string]
  -g, --graphql  [boolean] [default: false]
  -p, --project  Project name of the current application [string] [required]