swagger-markdown

Converts a swagger or OpenAPI file to MarkDown

Installation

Using go install

go install github.com/omid/swagger-markdown@latest

From source

git clone https://github.com/omid/swagger-markdown.git
cd swagger-markdown
go build

Usage

swagger-markdown -i <inputFile> -o <outputFile>

Example

swagger-markdown -i ./testdata/sample-swagger.yaml -o ./testdata/sample-output.md

Development Usage

If you're developing or testing locally:

go run main.go -i ./testdata/sample-swagger.yaml -o ./testdata/sample-output.md