Skip to content
kongchen edited this page Jun 28, 2013 · 2 revisions

Swagger your API Document with Examples

Swagger lets you write your API document near your source code to keep it up-to-date, and provides a pretty ui (swagger-ui) to display the document. The document shows the url, parameters, error codes and descriptions for each of your APIs, and you can even try it out!

It's good enough for most cases.

However, if you wanna to put examples in your document to describe your API more precise, vivid and clear, it seems impossible for swagger.

This tool makes this impossible possible!

Go to check out the Tutorials to see how this happens.