Download - Maintainable consumers
26 March 2014Bruno Pedro
Maintainable Consumers
Bruno Pedro Web and Cloud Computing Technologist with over ten years’ experience. CTO of GetApp. Editor at APIUX.com.
http://brunopedro.com/
Summary• What is a maintainable consumer
• Factors that influence maintainability
• Defending your implementation
• Reacting to changes
Maintainable
• prevent unexpected downtime
• identify and correct problems
• maximize efficiency and reliability
• cope with changes
API Documentation
Your Own Consumer vs SDK
Unit and Integration Tests
Alerts
Documentation changes• Get notified by the provider
• 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 authorization layer, etc.
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
Summary• Write code that can cope with changes
• Evaluate API Documentation
• Write unit and integration tests
• Get alerts when things break
Questions?
26 March 2014Bruno Pedro
Maintainable Consumers