Example Swagger API Documentation

Style Guide

Edit using Sublime Text 3 and the .sublime-project file in this repository. You will also need to install the following plugins:

• Neon Color Scheme

Installation

This requires that both npm and grunt-cli are installed. After setting the appropriate proxy settings, on OS X this can be accomplished with:

brew install npm
npm install -g grunt
npm install -g grunt-cli

In order to generate documentation, you will need a few other packages:

npm install
grunt setup

Updating documentation

Before updating these documents, please familiarize yourself with the official Swagger Spec and JSON Schema.

Also see:

• http://spacetelescope.github.io/understanding-json-schema/

To generate HTML (site/index.html), run:

grunt build

If you wish to view live updates while you are editing, the following command will open the generated code in your browser and regenerate the HTML whenever you update the source:

grunt server

When adding this repository to a CI server where you only want to test the Swagger without generating HTML, use:

grunt test