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
470
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.2k
Fostering a culture of collaboration
benbalter
0
200
Growing open source communities on GitHub around your WordPress plugin or theme
benbalter
1
220
It takes a digital village
benbalter
1
400
Open source workflows in highly regulated environments
benbalter
0
82
Optimize for Developer Happiness
benbalter
0
270
The technology is the easy part
benbalter
2
260
How to foster an open source culture inside Government
benbalter
3
2.3k
Open source inspired workflows for open (and closed) geospatial data
benbalter
0
140
Other Decks in Technology
See All in Technology
早くて強い「リアルタイム解析基盤」から広げるマルチドメイン&プロダクト開発
plaidtech
PRO
1
120
貧民的プログラミングのすすめ
kakehashi
PRO
2
320
AIエージェント元年@日本生成AIユーザ会
shukob
1
290
Amazon Bedrock Knowledge basesにLangfuse導入してみた
sonoda_mj
2
310
DeepSeekとは?何がいいの? - Databricksと学ぶDeepSeek! 〜これからのLLMに備えよ!〜
taka_aki
2
210
最近のラズピッピいじり / 20250308-rpijam-13th-birthday
akkiesoft
0
130
Linuxのブートプロセス
sat
PRO
6
100
IAMのマニアックな話2025
nrinetcom
PRO
6
1.6k
役員・マネージャー・著者・エンジニアそれぞれの立場から見たAWS認定資格
nrinetcom
PRO
5
6.9k
結果的にこうなった。から見える メカニズムのようなもの。
recruitengineers
PRO
1
130
Platform Engineeringで クラウドの「楽しくない」を解消しよう
jacopen
4
300
困難を「一般解」で解く
fujiwara3
9
2.9k
Featured
See All Featured
Optimizing for Happiness
mojombo
377
70k
Fight the Zombie Pattern Library - RWD Summit 2016
marcelosomers
233
17k
GraphQLとの向き合い方2022年版
quramy
44
14k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
29
1.1k
BBQ
matthewcrist
87
9.5k
Designing for Performance
lara
605
68k
Testing 201, or: Great Expectations
jmmastey
42
7.2k
Building Adaptive Systems
keathley
40
2.4k
It's Worth the Effort
3n
184
28k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
What's in a price? How to price your products and services
michaelherold
244
12k
Large-scale JavaScript Application Architecture
addyosmani
511
110k
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