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

1. 26 March 2014
Bruno Pedro
Maintainable Consumers

2. Bruno Pedro
Web and Cloud Computing Technologist with
over ten years’ experience. CTO of GetApp.
Editor at APIUX.com.
http://brunopedro.com/

3. Summary
• What is a maintainable consumer
• Factors that influence maintainability
• Defending your implementation
• Reacting to changes

4. Maintainable
• prevent unexpected downtime
• identify and correct problems
• maximize efficiency and reliability
• cope with changes

5. API Documentation

6. Your Own Consumer vs SDK

7. Unit and Integration Tests

8. Alerts

9. Documentation changes
• Get notified by the provider
• twitter
• email
• API Changelog
• alerts by email

10. Documentation changes
• API Changelog
• email alerts, RSS and JSON feeds

11. Implement a Façade

12. Consumer Generation
• collection
• markdown
• functionsnodeunit

13. Tests
• POSTMAN Collection Runner

14. Tests
• Runscope Radar

15. Reacting to changes
• Technical changes
• detected through tests
• implement fix
• e.g. invalid certificate, changed
authorization layer, etc.

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. Summary
• Write code that can cope with changes
• Evaluate API Documentation
• Write unit and integration tests
• Get alerts when things break

18. Questions?

19. 26 March 2014
Bruno Pedro
Maintainable Consumers