scryner / swagroller

A CLI tool that generates OpenAPI specification web page from YAML

Swagroller

Swagroller is a command-line interface (CLI) tool that converts a YAML file to an OpenAPI specification document, and generates a simple static web page that can be run anywhere, even just on a file system.

Installation

You can Swagroller by using the following command:

$ go get github.com/scryner/swagroller

You can also clone the repository and build the binary from source:

$ git clone https://github.com/scryner/swagroller.git
$ cd swagroller
$ go build

Usage

To build a static web page from a specification file in YAML, simply run the following command:

$ swagroller build <path-to-yaml-file>

You can also serve the contents to your web browser using the following command:

$ swagroller serv <path-to-yaml-file>