Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
User Focused API Design
Search
Labcodes Software Studio
May 10, 2017
Technology
0
73
User Focused API Design
Talk given on May 10th at Django NYC Meetup
Labcodes Software Studio
May 10, 2017
Tweet
Share
More Decks by Labcodes Software Studio
See All by Labcodes Software Studio
Sua aplicação web aguenta o tranco?
labcodes
0
10
Como Gerenciar Trocas de Contexto em tempo de Pandemia
labcodes
0
41
Débito Técnico: Porque isso vai estragar teu Software
labcodes
1
280
80 tiros não são disparados por engano
labcodes
0
54
Recompose - O lodash para React
labcodes
2
72
Aprendendo com os erros
labcodes
3
130
Usando recursos avançados da ORM do Django para consultas mais eficientes
labcodes
2
200
Making smarter queries with advanced ORM resources
labcodes
2
160
Explorando QuerySets do Django
labcodes
2
160
Other Decks in Technology
See All in Technology
**強い**エンジニアのなり方 - フィードバックサイクルを勝ち取る / grow one day each day
soudai
61
18k
プロトタイピングによる不確実性の低減 / Reducing Uncertainty through Prototyping
ohbarye
3
230
The AI Revolution Will Not Be Monopolized: How open-source beats economies of scale, even for LLMs (QCon London)
inesmontani
PRO
1
150
HEXA OSINT CTF V3 作戦会議
meow_noisy
0
110
反実仮想機械学習とは何か
usaito
PRO
6
2k
Apple Vision Pro trial session
akkeylab
0
120
社内勉強会運営のコツ
senoo
6
1.1k
The CloudCompare project by Dr. Daniel Girardeau-Montaut
kentaitakura
0
510
最近たまに見かけるTiDBってなんだ? - Findy
pingcap0315
2
580
PHPカンファレンス小田原2024
ysknsid25
3
660
DevOpsメトリクスとアウトカムの接続にトライ!開発プロセスを通して計測できるメトリクスの活用方法
ham0215
1
190
Databricks:『生成AI World Cup』のご案内
databricksjapan
2
150
Featured
See All Featured
Documentation Writing (for coders)
carmenintech
59
3.9k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
240
1.2M
How To Stay Up To Date on Web Technology
chriscoyier
782
250k
Why You Should Never Use an ORM
jnunemaker
PRO
50
8.6k
Agile that works and the tools we love
rasmusluckow
324
20k
GraphQLとの向き合い方2022年版
quramy
31
12k
How to Ace a Technical Interview
jacobian
272
22k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
115
18k
Clear Off the Table
cherdarchuk
83
310k
JavaScript: Past, Present, and Future - NDC Porto 2020
reverentgeek
39
4.4k
YesSQL, Process and Tooling at Scale
rocio
163
13k
Code Reviewing Like a Champion
maltzj
513
39k
Transcript
Renato Oliveira USER FOCUSED API DESIGN
Who am I • Recife, Brazil • Co-founder and Software
Engineer at Labcodes • PUG-PE & Python Brasil • DSF • Communities <3 • Coffee <3
Labcodes • Software studio de Recife para o mundo •
Tecnologias que trabalhamos • Labcodes e Comunidade Labcodes
DISCLAIMER
None
Your API is a User Interface
Your API is a User Interface
Your API is a User Interface
API Design
There are people on the other side
There are users on the other side!
On what should we focus? • Functionality • Usability
USER EXPERIENCE
DEVELOPER EXPERIENCE
UX Honeycomb usable useful valuable desirable accessible credible findable
How to measure your API usability? • Task invocation ratio
• Structure • Navigation • Time to first call • Error handling
UX without user research is not UX
User Research • Participatory design • Persona development
Test • Write client code • Metrics
Documentation • Getting started guide • Common use cases •
Sandbox
Error Handling • Different errors requires different exceptions • Descriptive
error messages • “Errors should never pass silently. Unless explicitly silenced”
Top-down approach • How the API should behave? • Prototype
• Iterate • Feedback
Prototype and Iterate
Design/Prototype Implementation Customer
Design/Prototype Implementation Customer :D
API Blueprint • apiblueprint.org • Mock tools • Tests
Empathy • Understand • Put yourself on your users’ shoes
• All of your users (Personas)
Functionalities are eternal • Or at least as long your
API version lasts • Please don’t break clients by removing functionalities • Users only use your API once, everything else is automated
“APIs are starting to look more like the product and
less like the technology.” Jason Harmon, Head of API Design @ PayPal
Obrigado! twitter.com/_renatoOliveira github.com/renatoliveira www.labcodes.com.br speakerdeck.com/labcodes
None