Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Harmony in API Design

Avatar for API Strategy & Practice Conference API Strategy & Practice Conference
October 24, 2013
Technology
220
1

Harmony in API Design

By Jakub Nesetril @ API Strategy & Practice Conference
San Francisco, October 23-24-25, 2013

Avatar for API Strategy & Practice Conference

API Strategy & Practice Conference

October 24, 2013

More Decks by API Strategy & Practice Conference

See All by API Strategy & Practice Conference
APIStrat 2016 | The end of polling: why and how to transform a REST API into a Data Streaming API (Audrey Neveu)
Avatar for API Strategy & Practice Conference apistrat
12
340
APIStrat 2016 | OpenAPI Trek: Beyond API Documentation (Arnaud Lauret)
Avatar for API Strategy & Practice Conference apistrat
5
250
APIStrat 2016 | Flying Dreams: Real-Time Communication from the Edge of Space (Jonathan Barton, Neha Abrol)
Avatar for API Strategy & Practice Conference apistrat
1
180
APIStrat 2016 | On-prem support? That was so 1982 (Charlie Ozinga)
Avatar for API Strategy & Practice Conference apistrat
0
150
APIStrat 2016 | Effortless microservices in production with Kubernetes (Ken Wronkiewicz)
Avatar for API Strategy & Practice Conference apistrat
0
190
Song by Tony Blank
Avatar for API Strategy & Practice Conference apistrat
0
220
API Lifecycle Manager by Steve Fonseca
Avatar for API Strategy & Practice Conference apistrat
2
280
APIs In The Enterprise: How Walgreens Formed It's Digital Business by Drew Schweinfurth
Avatar for API Strategy & Practice Conference apistrat
1
420
Developers Are Difficult by Andrew Noonan
Avatar for API Strategy & Practice Conference apistrat
0
160

Other Decks in Technology

See All in Technology
関東Kaggler会発表資料
Avatar for takoi takoi
1
230
取引先から届く 「セキュリティチェックシート」の読み解き方
Avatar for かーでぃ kamadamakoto
0
150
MulticaとPi Coding Agentで、小規模OSSを30本同時運用した流れ
Avatar for eiei114 eiei114
0
110
FORENSIA: ローカルLLMフォレンジックハーネス
Avatar for S.Nakano sumeshi
2
390
DatadogのBits Chatが開発組織にもたらしたもの / What Bits Chat Has Brought Us
Avatar for SMS tech sms_tech
1
270
ホームラボ紹介
Avatar for 世良泰明 y_sera15
0
180
修正PRを食べてレビュースキルが賢くなる：Claude Codeによる自己改善サイクル
Avatar for um(うめ) yuyaumetsu
6
1.5k
【CEDEC2026】Creative Approaches to Localizing the Dialects and Unique Speech of Umamusume: Pretty Derby Characters in English
Avatar for Cygames, Inc. cygames
PRO
3
22k
Model Studio CLI × Token Plan
Avatar for 尾関将樹 | めい maigo999
0
180
サイバー捜査員研修（前半）
Avatar for Nomizo Nomizo nomizone
1
2k
変化の早いClaude Codeを 書籍に落とし込む
Avatar for Oikon oikon48
7
1.4k
【CEDEC2026】『ウマ娘 プリティーダービー』 英語版のキャラクターの方言や口調をローカライズするための創造的アプローチ
Avatar for Cygames, Inc. cygames
PRO
2
970

Featured

See All Featured
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
Avatar for Michelle Schulp Hunt marktimemedia
31
2.8k
HTML-Aware ERB: The Path to Reactive Rendering @ RubyCon 2026, Rimini, Italy
Avatar for Marco Roth marcoroth
3
430
Beyond borders and beyond the search box: How to win the global "messy middle" with AI-driven SEO
Avatar for David Carrasco davidcarrasco
3
210
Mobile First: as difficult as doing things right
Avatar for Swwweet swwweet
225
10k
Side Projects
Avatar for Sacha Greif sachag
455
43k
No one is an island. Learnings from fostering a developers community.
Avatar for Antonio thoeni
21
3.8k
Navigating Algorithm Shifts & AI Overviews - #SMXNext
Avatar for Aleyda Solis aleyda
1
1.6k
Public Speaking Without Barfing On Your Shoes - THAT 2023
Avatar for David Neal reverentgeek
1
530
Speed Design
Avatar for Sergey Chernyshev sergeychernyshev
33
2k
Tell your own story through comics
Avatar for letsgokoyo letsgokoyo
1
1k
Building Applications with DynamoDB
Avatar for Matt Wood mza
96
7.2k
Connecting the Dots Between Site Speed, User Experience & Your Business [WebExpo 2025]
Avatar for Tammy Everts tammyeverts
11
990

Transcript

  1. Harmony in API Design [email protected]

  2. What is an API?

  3. None
  4. None

  5. API is UI to Data

  6. API is UI to Data

  7. API is UI to Data User Experience

  8. API is UI to Data User Experience Design

  9. API is UI to Data User Experience Design Emotions

  10. API is UI to Data User Experience Design Subjective Emotions

  11. API is UI to Data User Experience Design Subjective Emotions

    Culturally Dependent

  12. API is UI to Data User Experience Design Subjective Simplicity

    Emotions Culturally Dependent

  13. API is UI to Data User Experience Design Subjective Simplicity

    Emotions Productivity Culturally Dependent

  14. API is UI to Data User Experience Design Subjective Simplicity

    Conversion Rates Emotions Productivity Culturally Dependent

  15. API is UI to Data User Experience Design Subjective Simplicity

    Conversion Rates Emotions Productivity Usability Studies Culturally Dependent

  16. API is UI to Data User Experience Design Subjective Simplicity

    Conversion Rates Emotions Productivity Culturally Dependent Hackathons

  17. Nobody thinks THEIR design sucks

  18. None
  19. None

  20. Provider Consumer

  21. Provider Consumer Java Rails Scala Erlang

  22. Provider Consumer Java Rails Scala Erlang jQuery ObjC PHP

  23. Provider Consumer Uptime Caching Security Maintenance Versioning Validation Java Rails

    Scala Erlang jQuery ObjC PHP

  24. Provider Consumer Uptime Caching Security Maintenance Versioning Validation Can It

    Be Done? Debugging Support TTFHW Example Latency Java Rails Scala Erlang jQuery ObjC PHP

  25. So?

  26. 1. Start With a Wireframe •a design intent •usually an

    API description language •at Apiary we use API Blueprint

  27. 2. Involve Your Customers •find your early-adopters before you code

    •create an API mock that they can use •fork/pull-request

  28. 3. Have Great Documentation •generated automatically •must be exhaustive and

    up-to-date •your code is automatically tested; so must your documentation

  29. 4. Separate Contract from Implementation

  30. Summary •API is UI for Data & Interface between cultures

    •Involve your customers early •Automate

  31. @apiaryio http://apiary.io/ ! @jakubnesetril Thank You