API Documentation with Swagger UI

Jiang Wu

2014-12-20

Jiang Wu API Documentation with Swagger UI 2014-12-20 1 / 6

Questions

Have you built API before?

What's the most important feature of an API?

Jiang Wu API Documentation with Swagger UI 2014-12-20 2 / 6

Developing API is hard

Stability

Compatibility

RESTful

Documentation

Jiang Wu API Documentation with Swagger UI 2014-12-20 3 / 6

Live doc!

Live test

OAuth2 (backend provided by Doorkeeper)

Integration with Grape

Example: http://petstore.swagger.wordnik.com/

Jiang Wu API Documentation with Swagger UI 2014-12-20 4 / 6

Bad parts of Swagger UI

Ine�cient documentation

Unstable

Not support multiple versions

Jiang Wu API Documentation with Swagger UI 2014-12-20 5 / 6

Thanks!

Questions?

Jiang Wu API Documentation with Swagger UI 2014-12-20 6 / 6