The API Facade Pattern: Overview - Episode 1
Download as PPTX, PDF20 likes12,031 views
This document provides an overview of a webinar series on API facades. The webinar series will discuss how API facades can provide a simple interface to complex backend systems over four episodes. Episode 1 will cover the goal of API facades, common problems they address, anti-patterns to avoid, how facades provide a solution, and how to implement them. Using an API facade can help mediate between the ideal API design and existing systems, while providing benefits like adapting to different use cases and keeping pace with developers.
The API Facade Pattern: Overview - Episode 1
- 1. API Façade: Overview Episode 1 Webinar Shorts March 2012 Series Brian Mulloy Apigee @landlessness @apigee
- 4. New! IRC Channel #api-craft on freenode
- 5. Webinar Shorts - March 2012 New! Episode 1 The API Facade: Overview Tuesday, March 6th Episode 2 The API Facade: Common Patterns Tuesday, March 13th Episode 3 The API Facade: Technology Tuesday, March 20th Episode 4 The API Facade: People Tuesday, March 27th
- 6. Episode 1 Topics • The Goal • The Problem • The Anti-Patterns • The Solution • How To • Benefits
- 7. The Goal
- 8. App App App World of API Internal App API User Store Developer APIs Team Systems
- 9. App App App World of API Internal App API User Store Developer APIs Team Systems
- 11. The Problem
- 12. System of Record Virtues • Stable • Dependable • Runs the Business Vices • Legacy Technology Big • Interdependencies • Slowly Changing System
- 13. Content Big DB Management JDBC RSS SOAP System
- 15. Anti-pattern #1 Build Up Virtues XML • Version 1 • Quick Expose Objects • Understood by Internal Devs Vices • Fine-grained Big • Confusing to App Devs System • Inflexible
- 16. Anti-pattern #2 Standards Standards Committee Doc Virtues • Version 1 • Sense of Unification • Comprehensive Vices • Slow XML XML XML • Lack of Adherence Expose RSS Expose Objects Expose Tables • Mediocre or Multiple Designs Content Big System DB Management • Subject to Interpretation
- 17. Anti-pattern #3 Competitor’s Copy Cat API Docs Virtues • Version 1 • Quick • App Dev Familiarity Vices • Not Differentiated XML XML XML • Value Not Expose RSS Expose Objects Expose Tables Leveraged Content Big System DB Management
- 18. The Solution
- 19. API Team Product Community Engineers Operations QA Architect Manager Manager
- 20. API Façade
- 21. App App Developer API Facade Content Big DB Management JDBC RSS SOAP System
- 23. “ Use the façade pattern when you want to provide a simple interface to a complex subsystem. Subsystems often get more complex as they evolve.
- 24. How To
- 25. 1. Design the Ideal API 2. Implement Design with Stubs 3. Mediate between Façade and Systems
- 26. One Big Problem 1. Build up from systems of record App XML XML XML XML XML XML 1. Objects Tables RSS RSS Tables RSS Content Big DB Management JDBC RSS SOAP System
- 27. Three Small Problems 1. Design the Ideal API 2. Implement Design with Stubs as Façade App 3. Mediate between Façade and Systems Developer 1. Ideal Design 2. API Facade 3. Mediate Content Big DB Management JDBC RSS SOAP System
- 28. Façade as Gateway • Handle Common Patterns • Authenticate & Authorize • Version • Store Data for Analysis
- 29. The Benefits
- 30. Adapt to Use Cases Internal Partners Customers Open
- 31. Keep Pace with Developers App App App World of API Internal App API User Store Developer APIs Team Systems
- 32. Extensible AND Consistent API API Facade Content DB Management SOAP JDBC
- 33. Enterprise API Engine Internal Open Partners Customers
- 34. Questions?
- 35. THANK YOU Subscribe to API webinars at: youtube.com/apigee
- 37. THANK YOU Questions and ideas to: groups.google.com/group/api-craft
- 38. THANK YOU Contact me at: @landlessness brian@apigee.com
Editor's Notes
- #2: Creative Commons Attribution-Share Alike 3.0 United States License