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
410
Open source workflows in highly regulated environments
benbalter
0
85
Optimize for Developer Happiness
benbalter
0
270
The technology is the easy part
benbalter
2
270
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
ブラウザのレガシー・独自機能を愛でる-Firefoxの脆弱性4選- / Browser Crash Club #1
masatokinugawa
1
510
ドキュメント管理の理想と現実
kazuhe
1
230
watsonx.data上のベクトル・データベース Milvusを見てみよう/20250418-milvus-dojo
mayumihirano
0
120
Writing Ruby Scripts with TypeProf
mame
0
360
SDカードフォレンジック
su3158
1
640
Automatically generating types by running tests
sinsoku
2
3.7k
SREからゼロイチプロダクト開発へ ー越境する打席の立ち方と期待への応え方ー / Product Engineering Night #8
itkq
2
1k
AIにおけるソフトウェアテスト_ver1.00
fumisuke
0
190
PicoRabbit: a Tiny Presentation Device Powered by Ruby
harukasan
PRO
2
250
Cross Data Platforms Meetup LT 20250422
tarotaro0129
1
760
クラウド開発環境Cloud Workstationsの紹介
yunosukey
0
190
地味にいろいろあった! 2025春のAmazon Bedrockアップデートおさらい
minorun365
PRO
1
440
Featured
See All Featured
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
41
2.2k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
addyosmani
5
560
Site-Speed That Sticks
csswizardry
5
500
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
19
1.2k
Adopting Sorbet at Scale
ufuk
76
9.3k
Being A Developer After 40
akosma
91
590k
Fireside Chat
paigeccino
37
3.4k
Producing Creativity
orderedlist
PRO
344
40k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
194
16k
Done Done
chrislema
183
16k
What’s in a name? Adding method to the madness
productmarketing
PRO
22
3.4k
Fontdeck: Realign not Redesign
paulrobertlloyd
83
5.5k
Transcript
! Three simple rules for building an API Ben Balter
@benbalter government@github.com 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
! data@agency.gov doesn’t scale
! data@agency.gov 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 government@github.com government.github.com