The document discusses how SDKs and code samples are cornerstones of API developer experience. It notes that decades ago, developers had to work with machine code directly, but now have access to higher-level languages, SDKs and code samples to more easily access and build on APIs. The document advocates that API providers should focus on automating the creation of dynamic code samples and SDKs to remove redundant work for developers and provide a premium developer experience.
19. 19
Input
Output
Checks and Validations
Encode Inputs
Serialize body
Build HTTP request
Make HTTP Call
Deserialize body
Decode to output
Handle errors
Configuration
Arguments for
API Call
Authentication
Credentials
An API Call
@APIMatic | @AdeelAli25
20. 20
Input
Output
Checks and Validations
Encode Inputs
Serialize body
Build HTTP request
Make HTTP Call
Deserialize body
Decode to output
Handle errors
Configuration
Arguments for
API Call
Authentication
Credentials
S
D
K
An API Call
@APIMatic | @AdeelAli25
21. API Wrappers
SDKs
21
There’s more to HTTP calls and
serialization/deserialization
○ Caching
○ Retries
○ Analytics
○ Validation
○ Error Messages
○ Authentication
○ Linking
@APIMatic | @AdeelAli25
24. 24
Code Samples for
Better DX
@APIMatic | @AdeelAli25
• Should demonstrate actual (non-theoretical) uses
of the API
• Should be runnable – developers be able to
prove that it works, before using it themselves
• Come with code playground – setup an
environment to start using a particular API
https://www.programmableweb.com/news/six-pillars-complete-developer-documentation/2011/09/12
39. DX
@APIMatic | @AdeelAli25
Thank You
If you talk to a
man in a language
he understands,
that goes to his
head. If you talk to
him in his
language, that
goes to his heart