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
80
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
12
Como Gerenciar Trocas de Contexto em tempo de Pandemia
labcodes
0
41
Débito Técnico: Porque isso vai estragar teu Software
labcodes
1
310
80 tiros não são disparados por engano
labcodes
0
55
Recompose - O lodash para React
labcodes
2
76
Aprendendo com os erros
labcodes
3
140
Usando recursos avançados da ORM do Django para consultas mais eficientes
labcodes
2
220
Making smarter queries with advanced ORM resources
labcodes
2
170
Explorando QuerySets do Django
labcodes
2
180
Other Decks in Technology
See All in Technology
自作Cコンパイラ 8時間の奮闘
soukouki
0
850
事前準備が肝!AI活用のための業務改革
layerx
PRO
1
400
やってやろうじゃないかメカアジャイル! / Let's do it, mechanical agile!
psj59129
1
700
DuckDB雑紹介(1.1対応版)@DuckDB座談会
ktz
6
1.4k
20240912 JJUGナイトセミナー
mii1004
0
140
フルカイテン株式会社 採用資料
fullkaiten
0
32k
サーバー管理しないサーバーサービスManaged DevOps Pool
kkamegawa
0
140
『GRANBLUE FANTASY: Relink』最高の「没入感」を実現するカットシーン制作手法とそれを支える技術
cygames
1
160
持続可能なソフトウェア開発を支える『GitHub CI/CD実践ガイド』
tmknom
8
1.5k
Google CloudのLLM活用の選択肢を広げるVertex AIのパートナーモデル
nayuts
0
130
エムスリーエビデンス創出プロダクトチーム紹介資料 / Introduction of M3 Create Evidence Team
m3_engineering
0
100
Cloud Run と GitHub Template Repository による軽量なアプリケーションプラットフォーム/ #nikkei_tech_talk
nikkei_engineer_recruiting
0
120
Featured
See All Featured
From Idea to $5000 a Month in 5 Months
shpigford
379
46k
Statistics for Hackers
jakevdp
794
220k
Art, The Web, and Tiny UX
lynnandtonic
294
20k
Fantastic passwords and where to find them - at NoRuKo
philnash
48
2.8k
Code Reviewing Like a Champion
maltzj
517
39k
Put a Button on it: Removing Barriers to Going Fast.
kastner
58
3.4k
What’s in a name? Adding method to the madness
productmarketing
PRO
21
3k
ParisWeb 2013: Learning to Love: Crash Course in Emotional UX Design
dotmariusz
109
6.9k
Build your cross-platform service in a week with App Engine
jlugia
228
18k
Facilitating Awesome Meetings
lara
49
6k
Making Projects Easy
brettharned
113
5.8k
A Philosophy of Restraint
colly
202
16k
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