Download as PDF, PPTX
![[…] there is nothing
made by human beings
that does not involve a
design decision
somewhere.Bill
Moggridge](https://image.slidesharecdn.com/fiveuniversalprinciplesofapidesign-151207172702-lva1-app6891/75/Five-Universal-Principles-of-API-Design-2-2048.jpg)
Uploaded byCA Technologies
Five Universal Principles of API Design
This document outlines five universal principles of API design: flexibility-usability tradeoff, forgiveness, immersion, iteration, and satisficing. It emphasizes the importance of balancing functionality with ease of use, helping users recover from mistakes, encouraging exploration, and adopting an iterative design process. Additionally, it highlights that optimal design decisions are often not the best due to resource constraints, suggesting that effective design requires continuous evaluation and adaptation.
More Related Content
![[資料庫][Mssql][AlwaysOn]](https://cdn.slidesharecdn.com/ss_thumbnails/mssqlalwayson-160525224232-thumbnail.jpg?width=640&height=640&fit=bounds)
Similar to Five Universal Principles of API Design
Five Universal Principles of API Design
- 1. Five Universal Principlesof API Design Ronnie Mitra DevOps: API Management and Application Development CA Technologies Director of API Design DO3T26T @mitraman #CAWorld
- 2. […] there isnothing made by human beings that does not involve a design decision somewhere.Bill Moggridge
- 3. Why do wewant better APIs? Expose More Capabilities Develop Better Applications Faster Acquire More Developers & Users
- 4. Universal Principles ofDesign Rockport Publishers Inc. 2007 Authors: William Lidwell Kritina Holden Jill Butler
- 5. 80/20 Rule Accessibility Advance Organizer Aesthetic-UsabilityEffect Affordance Alignment Anthropomorphic Form Archetypes Area Alignment Attractiveness Bias Baby-Face Bias Biophilia Effect Cathedral Effect Chunking Classical Conditioning Closure Cognitive Dissonance Color Common Fate Comparison Confirmation Consistency Constancy Constraint Contour Bias Control Convergence Cost-Benefit Defensible Space Depth of Processing Design by Committee Desire Line Development Cycle Entry Point Errors Expectation Effect Exposure Effect Face-ism Ratio Factor of Safety Feedback Loop Fibonacci Sequence Figure-Ground Relationship Fitts’ Law Five Hat Racks Flexibility-Usability Tradeoff Forgiveness Form Follows Function Framing Freeze-Flight-Fight-Forfeit Garbage In-Garbage Out Golden Ratio Good Continuation Gutenberg Diagram Hick’s Law Hierarchy Hierarchy of Needs Highlighting Horror Vacui Hunter-Nurturer Fixations Iconic Representation Immersion Inattentional Blindness Interference Effects Inverted Pyramid Iteration Law of Pragnanz Layering Legibility Life Cycle Mapping Mental Model Mimicry Mnemonic Device Modularity Most Advanced Yet- Acceptable Most Average Facial- Appearance Effect Normal Distribution Not Invented Here Nudge Ockham’s Razor Operant Conditioning Orientation Sensitivity Performance Load Performance Versus Preference Personas Picture Superiority Effect Priming Progressive Disclosure Propositional Density Prospect-Refuge Prototyping Proximity Readability Recognition Over Recall Red Effect Redundancy Rosetta Stone Rule of Thirds Satisficing Savanna Preference Scaling Fallacy Scarcity Self-Similarity Serial Position Effects Shaping Signal-to-Noise Ratio Similarity Stickiness Storytelling Structural Forms Symmetry Threat Detection Three-Dimensional Projection Top-Down Lighting Bias Uncanny Valley Uncertainty Principle Uniform Connectedness Veblen Effect Visibility Visuospatial Resonance Von Restorff Effect Wabi-Sabi Waist-to-Hip Ratio Wayfinding Weakest Link
- 6. 80/20 Rule Accessibility Advance Organizer Aesthetic-UsabilityEffect Affordance Alignment Anthropomorphic Form Archetypes Area Alignment Attractiveness Bias Baby-Face Bias Biophilia Effect Cathedral Effect Chunking Classical Conditioning Closure Cognitive Dissonance Color Common Fate Comparison Confirmation Consistency Constancy Constraint Contour Bias Control Convergence Cost-Benefit Defensible Space Depth of Processing Design by Committee Desire Line Development Cycle Entry Point Errors Expectation Effect Exposure Effect Face-ism Ratio Factor of Safety Feedback Loop Fibonacci Sequence Figure-Ground Relationship Fitts’ Law Five Hat Racks Form Follows Function Framing Freeze-Flight-Fight-Forfeit Garbage In-Garbage Out Golden Ratio Good Continuation Gutenberg Diagram Hick’s Law Hierarchy Hierarchy of Needs Highlighting Horror Vacui Hunter-Nurturer Fixations Iconic Representation Inattentional Blindness Interference Effects Inverted Pyramid Law of Pragnanz Layering Legibility Life Cycle Mapping Mental Model Mimicry Mnemonic Device Modularity Most Advanced Yet Acceptable Most Average Facial- Appearance Effect Normal Distribution Not Invented Here Nudge Ockham’s Razor Operant Conditioning Orientation Sensitivity Performance Load Performance Versus Preference Personas Picture Superiority Effect Priming Progressive Disclosure Propositional Density Prospect-Refuge Prototyping Proximity Readability Recognition Over Recall Red Effect Redundancy Rosetta Stone Rule of Thirds Savanna Preference Scaling Fallacy Scarcity Self-Similarity Serial Position Effects Shaping ignal-to-Noise Ratio Similarity Stickiness Storytelling Structural Forms Symmetry Threat Detection Three-Dimensional Projection Top-Down Lighting Bias Uncanny Valley Uncertainty Principle Uniform Connectedness Veblen Effect Visibility Visuospatial Resonance Von Restorff Effect Wabi-Sabi Waist-to-Hip Ratio Wayfinding Weakest Link Flexibility-Usability Tradeoff Forgiveness Immersion Satisficing Iteration
- 7.
- 8. Flexibility “How many problemswill this help me solve?” “How many ways can I use this?” “How much stuff can this thing do?”
- 9. Usability “How easily canI accomplish my goals?” “How difficult is it too get started?” “What do I need to know?”
- 10. adding functionality increases complexity LowComplexity Minimum Capabilities
- 11. Maximum Capabilities adding functionalityincreases complexity High Complexity
- 12. added complexity canincrease confusion !!! Low Complexity High Complexity
- 13. An API designedfor applications GET /account GET /customer GET /transfers POST /transfer
- 14. An API designedfor an application dashboard GET /dashboardMetrics
- 15. Flexibility is valuablewhen we are uncertain about future user needs
- 16. Flexibility is valuablewhen we are uncertain about future user needs Data Chunking Querying Order of Calls Endpoint Location Data Model Capabilities APIClient
- 17.
- 18.
- 19. This is nota binary tradeoff Flexibility Usability
- 20. Every design decisionplaces you on the spectrum Maximum Flexibility Maximum Usability
- 21.
- 22. Forgiveness Help users recoverfrom mistakes Help users avoid making mistakes Warn users of danger ahead
- 23. APIClient Oh Larry…. I forgiveyou. ` I’ve made a horrible mistake!
- 24.
- 25. Encourage exploration andlearning by providing safe places Application Developer Client API !
- 26. Encourage exploration andlearning by providing safe places Application Developer Client API sandbox
- 27. Provide reversibility inthe API Client Application User UNDO
- 28. UNDO Provide reversibility inthe API Application User APIClient POST /undo
- 29.
- 30. The best momentsusually occur when a person’s body or mind is stretched to its limits in a voluntary effort to accomplish something difficult and worthwhile Mihaly Csikszentmihalyi
- 31.
- 33.
- 34. An Iterative APIDesign Approach 1 Determine Goals 2 Identify Users 3 Design Interface 4 Evaluate 5 Implement
- 35. Why? 1 Determine Goals 2Identify Users 3 Design Interface 4 Evaluate 5 Implement revenue reach innovation growth compliance intel
- 36. platform language organization distance knowledge risk profile investment 1 DetermineGoals 2 Identify Users 3 Design Interface 4 Evaluate 5 Implement For Whom? Expertise Goals Familiarity
- 37. Ideate, Experiment, Sketch& Prototype 1 Determine Goals 2 Identify Users 3 Design Interface 4 Evaluate 5 Implement
- 38. Test Assumptions 1 DetermineGoals 2 Identify Users 3 Design Interface 4 Evaluate 5 Implement Lab Evaluation Peer Evaluation User Observation Write Client Code Participatory Design
- 39. Design Doesn’t Stop 1Determine Goals 2 Identify Users 3 Design Interface 4 Evaluate 5 Implement Analyze Real Usage Identify Usability Bugs Improve Functionality Iterate and Evolve
- 40. Iterations will improvedesign API implementations are difficult to change Try to iterate before implementation
- 41.
- 42. Herbert A. Simon Searchingfor the best can only dissipate scarce cognitive resources; the best is the enemy of the good. “ ”
- 43. “The best designdecision is not always the optimal design decision.” Scale Revenue Competition -£ £ £
- 44. 5. Satisficing 4. Iteration 3.Immersion 2. Forgiveness 1. Flexibility-Usability Tradeoff
- 45. 80/20 Rule Accessibility Advance Organizer Aesthetic-UsabilityEffect Affordance Alignment Anthropomorphic Form Archetypes Area Alignment Attractiveness Bias Baby-Face Bias Biophilia Effect Cathedral Effect Chunking Classical Conditioning Closure Cognitive Dissonance Color Common Fate Comparison Confirmation Consistency Constancy Constraint Contour Bias Control Convergence Cost-Benefit Defensible Space Depth of Processing Design by Committee Desire Line Development Cycle Entry Point Errors Expectation Effect Exposure Effect Face-ism Ratio Factor of Safety Feedback Loop Fibonacci Sequence Figure-Ground Relationship Fitts’ Law Five Hat Racks Flexibility-Usability Tradeoff Forgiveness Form Follows Function Framing Freeze-Flight-Fight-Forfeit Garbage In-Garbage Out Golden Ratio Good Continuation Gutenberg Diagram Hick’s Law Hierarchy Hierarchy of Needs Highlighting Horror Vacui Hunter-Nurturer Fixations Iconic Representation Immersion Inattentional Blindness Interference Effects Inverted Pyramid Iteration Law of Pragnanz Layering Legibility Life Cycle Mapping Mental Model Mimicry Mnemonic Device Modularity Most Advanced Yet- Acceptable Most Average Facial- Appearance Effect Normal Distribution Not Invented Here Nudge Ockham’s Razor Operant Conditioning Orientation Sensitivity Performance Load Performance Versus Preference Personas Picture Superiority Effect Priming Progressive Disclosure Propositional Density Prospect-Refuge Prototyping Proximity Readability Recognition Over Recall Red Effect Redundancy Rosetta Stone Rule of Thirds Satisficing Savanna Preference Scaling Fallacy Scarcity Self-Similarity Serial Position Effects Shaping Signal-to-Noise Ratio Similarity Stickiness Storytelling Structural Forms Symmetry Threat Detection Three-Dimensional Projection Top-Down Lighting Bias Uncanny Valley Uncertainty Principle Uniform Connectedness Veblen Effect Visibility Visuospatial Resonance Von Restorff Effect Wabi-Sabi Waist-to-Hip Ratio Wayfinding Weakest Link
- 46. 46 © 2015CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Q & A
- 47. 47 © 2015CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Recommended Sessions SESSION # TITLE DATE/TIME DO3T25T Tech Talk: Hypermedia-Driven Orchestration in Microservices 11/18/2015 at 2:00 pm DO3X96S Tech Primer: Implementing Adaptable Microservices; A Methodology for Loosely- Coupled Components 11/18/2015 at 3:00 pm DO3X95S Tech Primer: Accelerating the Mobile App Development Process – How to Simplify Building Context Aware and Reactive Mobile Apps 11/18/2015 at 4:30 pm
- 48. 48 © 2015CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Must See Demos Unlock the Value of APIs API Developer Portal Theater 3 Simplify API Design & Creation Live API Creator Theater 3 Accelerate Mobile/IoT Development Mobile App Services Theater 3 Extend Existing Architectures API Gateway Theater 3
- 49. 49 © 2015CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD For More Information To learn more, please visit: http://cainc.to/Nv2VOe CA World ’15