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
Three simple rules for building APIs
Search
Ben Balter
March 31, 2015
Technology
1
400
Three simple rules for building APIs
APIs should be simple, semantic, and supported.
Ben Balter
March 31, 2015
Tweet
Share
More Decks by Ben Balter
See All by Ben Balter
A community of communities: Empowering maintainers to grow communities around their code
benbalter
1
1.1k
Fostering a culture of collaboration
benbalter
0
170
Growing open source communities on GitHub around your WordPress plugin or theme
benbalter
1
200
It takes a digital village
benbalter
1
310
Open source workflows in highly regulated environments
benbalter
0
72
Optimize for Developer Happiness
benbalter
0
250
The technology is the easy part
benbalter
2
250
How to foster an open source culture inside Government
benbalter
3
2.2k
Open source inspired workflows for open (and closed) geospatial data
benbalter
0
120
Other Decks in Technology
See All in Technology
NLP2024 参加報告LT ~RAGの生成評価と懇親戦略~ / nlp2024_attendee_presentation_LT_masuda
taro_masuda
1
190
Introduction to GKE x LLM
soma00333
0
140
社内勉強会運営のコツ
senoo
6
1.1k
オブザーバビリティの Primary Signals
onk
PRO
0
520
PHP"オレ"カンファレンスの告知
ysknsid25
0
240
「ふりかえりのふりかえり」をふりかえり、実のあるふりかえりにする
naitosatoshi
0
200
ビジネスとエンジニアリングの接合点 そしてコード品質がそこに及ぼす影響 v1.1 / The Intersections of Business and Engineering, and The Impact of Code Quality There (v1.1)
mtx2s
11
2.4k
Algyan イベント振り返り
linyixian
0
170
日本におけるデータエンジニアリングのこれまでとこれから
foursue
8
1.4k
Docker再入門 ~コンテナ・イメージ編~
yoshiyoshiharu
18
7k
The AI Revolution Will Not Be Monopolized: How open-source beats economies of scale, even for LLMs (QCon London)
inesmontani
PRO
0
140
Apple Vision Pro trial session
akkeylab
0
120
Featured
See All Featured
How To Stay Up To Date on Web Technology
chriscoyier
781
250k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
74
41k
RailsConf 2023
tenderlove
0
530
Statistics for Hackers
jakevdp
789
220k
GraphQLの誤解/rethinking-graphql
sonatard
49
9.2k
Being A Developer After 40
akosma
56
580k
Thoughts on Productivity
jonyablonski
57
3.8k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
8
8.3k
Become a Pro
speakerdeck
PRO
9
4.5k
Designing on Purpose - Digital PM Summit 2013
jponch
110
6.4k
Building Flexible Design Systems
yeseniaperezcruz
318
37k
Into the Great Unknown - MozCon
thekraken
10
980
Transcript
! Three simple rules for building an API Ben Balter
@benbalter
[email protected]
government.github.com
! All APIs should be three things
! APIs should be simple
! APIs should be semantic
! APIs should be supported
! All APIs should be simple
! Let’s say you want a list of open source
licenses…
! Option 0: scrape opensource.org Option 1: scrape spdx.org Option
2: parce an excel file
! Pro-tip: prototype your API
! choosealicense.com/licenses.json
! Meh.
! api.github.com/licenses
None
! api.github.com/licenses/mit
None
! api.github.com/repos/benbalter/gman
None
! All APIs should be semantic
! FDsys is not
! The FAR
! (Thunder and dramatic music)
None
! Web developers love 2+ MB XML files
! Data should be immediately valuable
! github.com/benbalter/so_far_so_good
! Data should make sense to computers
None
! Data should make sense to humans
None
! Data shouldn’t mimic their paper counterparts
! Data should be reimagined for the web
! Optimize for developer happiness
! All APIs should be supported
!
[email protected]
doesn’t scale
!
[email protected]
is a great way to answer the same
question over and over again
! Users have (the same) questions
! The only appropriate way to answer a question about
your API is with a URL
! Today, the first step to solving any problem is
to Google it
! Microsoft has been rocking the knowledge base for decades
! Bonus #1: Your community will answer its own questions
None
! Bonus #2: Collaborative documentation
None
None
! If you liked it then you should have put
a URL on it
! To review…
! APIs should be simple
! APIs should be semantic
! APIs should be supported
! Three simple rules for building an API Ben Balter
@benbalter
[email protected]
government.github.com