Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
User Focused API Design
Search
Labcodes Software Studio
May 10, 2017
Technology
120
0
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
User Focused API Design
Talk given on May 10th at Django NYC Meetup
Labcodes Software Studio
May 10, 2017
Transcript
31 slides
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
More Decks by Labcodes Software Studio
See All by Labcodes Software Studio
Sua aplicação web aguenta o tranco?
labcodes
0
75
Como Gerenciar Trocas de Contexto em tempo de Pandemia
labcodes
0
110
Débito Técnico: Porque isso vai estragar teu Software
labcodes
1
460
80 tiros não são disparados por engano
labcodes
0
110
Recompose - O lodash para React
labcodes
2
170
Aprendendo com os erros
labcodes
3
260
Usando recursos avançados da ORM do Django para consultas mais eficientes
labcodes
2
390
Making smarter queries with advanced ORM resources
labcodes
2
290
Explorando QuerySets do Django
labcodes
2
260
Other Decks in Technology
See All in Technology
OWASP AI Agentic Top10に準拠するクラウドネイティブなガードレールの実践(CNDW 2026)
keitah
1
450
落とし穴にハマってわかった 開発生産性を測るときに気をつけたいこと
munakata
3
490
SBOM 生成ツールで 2026 Minimum Elements はどこまで満たせるのか
gokken
0
160
Welcome JXL!
dynamis
0
120
実測データからサービスの成長余力を測る。負荷シナリオ・テストデータ・限界値の設計
kazatohiei
0
170
[関西Kaggler会 20261113] 続・コミュニティコンペのススメ
nejumi
0
200
PHPで家庭用ゲーム機の専用コントローラーをMIDIデバイスとして扱ってみる
wind111
0
200
gradle-best-practices 使ってみた
mikanichinose
0
230
プラガブルで宣言的なソフトウェアファクトリーを支えるTypeScript
timakin
2
680
現地速報! Microsoft Ignite アップデートレポート
kasada
1
460
Kiro Enterprise Management: 管理者が 1 か所で決め、全員の Kiro に届ける
inariku
PRO
0
100
AWS re:Invent 2026 FSI Pre-Event Networking Night
junjikoide
0
210
Featured
See All Featured
職位にかかわらず全員がリーダーシップを発揮するチーム作り / Building a team where everyone can demonstrate leadership regardless of position
madoxten
70
69k
The Illustrated Guide to Node.js - THAT Conference 2024
reverentgeek
1
620
Claude Code のすすめ
schroneko
67
230k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
9
1.7k
No one is an island. Learnings from fostering a developers community.
thoeni
21
3.9k
The Spectacular Lies of Maps
axbom
PRO
1
1.1k
Navigating the moral maze — ethical principles for Al-driven product design
skipperchong
2
700
Kristin Tynski - Automating Marketing Tasks With AI
techseoconnect
PRO
0
600
How to Align SEO within the Product Triangle To Get Buy-In & Support - #RIMC
aleyda
2
1.9k
Reflections from 52 weeks, 52 projects
jeffersonlam
356
22k
Building a A Zero-Code AI SEO Workflow
portentint
PRO
0
850
The browser strikes back
jonoalderson
0
2k