doki

module
v0.0.0-...-34b5496 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 29, 2016 License: MIT

README

DOKI

DOKI provides a simple interface to generate html documentation from swagger yaml files.

alt tag

Prerequisite

Create Documentation

A makefile using docker is available on the project. Just run:

    make docs

This will go through the ./project folder find the yaml file and generate the documentation in the ./docs folder.

Browse Swagger Documentation

Run:

	docker-compose up

Linux

    http://localhost:8080

Mac Os:

	http://$DockerMachineIp:8080

alt tag

Directories

Path Synopsis
Package yamlToJson provides a simple interface to generate swagger html structure from an yaml file.
Package yamlToJson provides a simple interface to generate swagger html structure from an yaml file.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL