Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Apiconf - Doc Driven Development

85 views

Published on

Sldes from ApiConf quick lightning talk

Published in: Internet
  • Be the first to comment

  • Be the first to like this

Apiconf - Doc Driven Development

  1. 1. API Documentation Gabriele Mittica - @gabrielemittica
  2. 2. APICONF 2017- Gabriele Mittica Documentation can be boring!
  3. 3. APICONF 2017- Gabriele Mittica Design Define Doc Code Test Manage
  4. 4. The goal ▪ Set interfaces and nomenclatures ▪ Define input and output ▪ Define error codes and responses APICONF 2017 – Gabriele Mittica
  5. 5. The problem ▪ It’s a long job ▪ List endpoints is not enough ▪ I need to put business logic in to documentation APICONF 2017 – Gabriele Mittica
  6. 6. How to ▪ Doc-driven and test-driven development ▪ Explain business logic ▪ Declare versioning and growth of APIs ▪ Don’t create doc by layout but by logic APICONF 2017 – Gabriele Mittica
  7. 7. APICONF 2017- Gabriele Mittica Doc Design Define CodeTest Manage
  8. 8. The doc is the only contract with the customer Thanks for Listening APICONF 2017- Gabriele Mittica

×