One-click Installation of swagger2markup via Brew and Generating Markdown Documentation

Published: 2022-01-25

1. One-click Installation

brew install swagger2markup-cli

2. Editing the Configuration File

mkdir ~/.swagger2markup
vim ~/.swagger2markup/config.properties

swagger2markup.markupLanguage=MARKDOWN
swagger2markup.outputLanguage=EN

3. Converting Documentation

wget http://api-staging.gs-robot.com/robot-task/v2/api-docs
swagger2markup convert -i api-docs -d ~/Documents/api -c ~/.swagger2markup/config.properties
swagger2markup convert -i api-docs -f ~/Documents/api/api_all -c ~/.swagger2markup/config.properties

4. Usage Guide

http://swagger2markup.github.io/swagger2markup/1.3.3/#_usage_guide_7