26 March 2014
Bruno Pedro
Maintainable Consumers
Bruno Pedro
Web and Cloud Computing Technologist with
over ten years’ experience. CTO of GetApp.
Editor at APIUX.com.
http...
Summary
• What is a maintainable consumer

• Factors that influence maintainability

• Defending your implementation

• Rea...
Maintainable
• prevent unexpected downtime

• identify and correct problems

• maximize efficiency and reliability

• cope w...
API Documentation
Your Own Consumer vs SDK
Unit and Integration Tests
Alerts
Documentation changes
• Get notified by the provider

• twitter

• email

• API Changelog

• alerts by email
Documentation changes
• API Changelog

• email alerts, RSS and JSON feeds











Implement a Façade
Consumer Generation
• collection





• markdown





• functionsnodeunit
Tests
• POSTMAN Collection Runner















Tests
• Runscope Radar















Reacting to changes
• Technical changes

• detected through tests

• implement fix

• e.g. invalid certificate, changed
auth...
Reacting to changes
• Functional changes

• harder to detect

• don’t change the Façade

• implement fix on the service lay...
Summary
• Write code that can cope with changes

• Evaluate API Documentation

• Write unit and integration tests

• Get a...
Questions?
26 March 2014
Bruno Pedro
Maintainable Consumers
Upcoming SlideShare
Loading in...5
×

Maintainable consumers

522

Published on

Slides of my talk at the API Strategy & Practice Conference Amsterdam 2014.

0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
522
On Slideshare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
1
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Maintainable consumers

  1. 1. 26 March 2014 Bruno Pedro Maintainable Consumers
  2. 2. Bruno Pedro Web and Cloud Computing Technologist with over ten years’ experience. CTO of GetApp. Editor at APIUX.com. http://brunopedro.com/
  3. 3. Summary • What is a maintainable consumer • Factors that influence maintainability • Defending your implementation • Reacting to changes
  4. 4. Maintainable • prevent unexpected downtime • identify and correct problems • maximize efficiency and reliability
 • cope with changes
  5. 5. API Documentation
  6. 6. Your Own Consumer vs SDK
  7. 7. Unit and Integration Tests
  8. 8. Alerts
  9. 9. Documentation changes • Get notified by the provider • twitter • email
 • API Changelog • alerts by email
  10. 10. Documentation changes • API Changelog • email alerts, RSS and JSON feeds
 
 
 
 
 

  11. 11. Implement a Façade
  12. 12. Consumer Generation • collection
 
 
 • markdown
 
 
 • functionsnodeunit
  13. 13. Tests • POSTMAN Collection Runner
 
 
 
 
 
 
 

  14. 14. Tests • Runscope Radar
 
 
 
 
 
 
 

  15. 15. Reacting to changes • Technical changes • detected through tests • implement fix
 • e.g. invalid certificate, changed authorization layer, etc.
  16. 16. Reacting to changes • Functional changes • harder to detect • don’t change the Façade • implement fix on the service layer • if not possible to fix, implement new methods
  17. 17. Summary • Write code that can cope with changes • Evaluate API Documentation • Write unit and integration tests • Get alerts when things break
  18. 18. Questions?
  19. 19. 26 March 2014 Bruno Pedro Maintainable Consumers
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×