API Documentation with Swagger UI

by Jiang Wu, GitCafe

Transcript

1. API Documentation with Swagger UI Jiang Wu 2014-12-20 Jiang Wu API Documentation with Swagger UI 2014-12-20 1 / 6
2. 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
3. Developing API is hard Stability Compatibility RESTful Documentation Jiang Wu API Documentation with Swagger UI 2014-12-20 3 / 6
4. 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
5. Bad parts of Swagger UI Inecient documentation Unstable Not support multiple versions Jiang Wu API Documentation with Swagger UI 2014-12-20 5 / 6
6. Thanks! Questions? Jiang Wu API Documentation with Swagger UI 2014-12-20 6 / 6