Last month ProgrammableWeb reported that Wordnik, a popular online dictionary and provider of the Wordnik API, had launched a brand new company called Reverb. Reverb is home to several developer tools including Swagger, a complete Framework for "describing, producing, consuming, and visualizing RESTful web services." This post is an overview of the Swagger interactive API Documentation specification and framework.
Automated API documentation that is consistent, easy to read and provides the ability to make live API calls is beneficial to both API providers and API consumers. Thorough, interactive API documentation helps developers better understand and easily consume APIs and also aids in API discovery. For API providers, offering APIs that are easy to understand and consume helps in the promotion of their APIs and can increase the adoption and consumption of their APIs by developers.
"At 3scale when we are asked how to make it faster and easier for developers to interact with an API without hesitation we say Swagger."