Tweet
Tweet

Slide 1

Slide 1 text

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

Slide 2

Slide 2 text

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

Slide 3

Slide 3 text

Developing API is hard Stability Compatibility RESTful Documentation Jiang Wu API Documentation with Swagger UI 2014-12-20 3 / 6

Slide 4

Slide 4 text

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

Slide 5

Slide 5 text

Bad parts of Swagger UI Inecient documentation Unstable Not support multiple versions Jiang Wu API Documentation with Swagger UI 2014-12-20 5 / 6

Slide 6

Slide 6 text

Thanks! Questions? Jiang Wu API Documentation with Swagger UI 2014-12-20 6 / 6