Home Swagger: A New Framework for Interactive API Documentation

Swagger: A New Framework for Interactive API Documentation

Today, Wordnik officially announced Swagger, a specification and framework for building interactive API documentation and sandboxes. The Swagger UI allows developers and non-developers to interact with an API and see how the API responds to different commands and parameters. It’s based on the technology that powers Wordnik’s own interactive API documentation and can work with both JSON and XML-based APIs.

You can find it in GitHub.

Wordnik co-founder and VP of Engineering Tony Tam said that it’s in use by a few other companies besides Wordnik, but he can’t disclose which companies.

The specification is language agnostic, and the framework implementation is available in HTML5, Scala and Java. There are also client generators for Scala, Java, Javascript, Ruby, PHP and Actionscript 3. More client support is planned.

Last week, Mashery announced an open source interactive API documentation system inspired in part by Wordnik’s API documentation.

About ReadWrite’s Editorial Process

The ReadWrite Editorial policy involves closely monitoring the gambling and blockchain industries for major developments, new product and brand launches, game releases and other newsworthy events. Editors assign relevant stories to in-house staff writers with expertise in each particular topic area. Before publication, articles go through a rigorous round of editing for accuracy, clarity, and to ensure adherence to ReadWrite's style guidelines.