Developer experience is the ease and effectiveness of discovering, learning, integrating with, and using an API. It follows the API value proposition in the design-principles hierarchy: preserve customer value and developer experience when adjusting API philosophy, governance, or style constraints. section 5.3.4
Build developer experience into the API delivery workflow through:
- Clear API documentation and specifications that help intended consumers discover and use the API. section 5.3.4 section 5.2.3
- Frictionless onboarding, including API keys or other authentication mechanisms, plus sandbox environments for testing. section 5.3.4
- Client SDKs that provide language-specific abstractions, consolidate multi-call operations, and hide recurring authentication work. section 9.3.1
- A deliberate support and community plan, followed by measurement and improvement of API behavior and consumer use. section 5.2.3
SDK abstraction for authentication
A raw API consumer may need to detect an expired authentication token, renew it, and retry the intended request. A well-built SDK can expose one function that hides this sequence, reducing integration effort and potentially support queries. section 9.3.1
Hierarchy of API Design Principles (Source: API Product Management by Andrea Zulian and Amancio Bouza)
Use the hierarchy to distinguish the API value proposition, developer experience, and the API philosophy that governs implementation choices. section 5.3.4
