6

API documentation with Swagger UI(LT)

Embed Size (px)

Citation preview

Page 1: API documentation with Swagger UI(LT)

API Documentation with Swagger UI

Jiang Wu

2014-12-20

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

Page 2: API documentation with Swagger UI(LT)

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

Page 3: API documentation with Swagger UI(LT)

Developing API is hard

Stability

Compatibility

RESTful

Documentation

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

Page 4: API documentation with Swagger UI(LT)

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

Page 5: API documentation with Swagger UI(LT)

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

Page 6: API documentation with Swagger UI(LT)

Thanks!

Questions?

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