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
HTTP API Design for iOS Applications
Search
Patrick Van Stee
August 16, 2013
Programming
11
500
HTTP API Design for iOS Applications
Patrick Van Stee
August 16, 2013
Tweet
Share
More Decks by Patrick Van Stee
See All by Patrick Van Stee
Raft: Consensus for Rubyists
vanstee
133
6.3k
Elixir and Ecto
vanstee
5
740
Bootstrap
vanstee
8
680
Consensus: An Introduction to Raft
vanstee
22
2.6k
Convergent Replicated Data Types
vanstee
4
610
Pour Over Brewing Method
vanstee
1
250
Celluloid & DCell
vanstee
4
410
Map Reduce & Ruby
vanstee
10
630
Other Decks in Programming
See All in Programming
酒飲んでたらテックリードになった話
spbaya0141
0
190
Goのエラースタックトレースの歴史と今後
sonatard
10
2.1k
Next.js App Router
quramy
13
2.3k
TypeScriptのパフォーマンス改善
yajihum
11
4.5k
一文字エイリアスのすすめ
fujimura
0
170
仕様と実装で学ぶOpenTelemetry
drumato
2
180
Sheets API使ってみた
toshi0383
2
180
Jetpack Composeとデザインシステム
rmakiyama
0
190
Fast JSX: Don't clone props object #28768
yossydev
1
230
AWS CDKコントリビュートTIPS / aws-cdk-contribution-tips
gotok365
4
590
Kotlin Multiplatform at Stable and Beyond (Android Makers 2024)
zsmb
0
590
Folding Cheat Sheet #4
philipschwarz
PRO
0
110
Featured
See All Featured
Build your cross-platform service in a week with App Engine
jlugia
226
17k
Optimizing for Happiness
mojombo
370
69k
The Mythical Team-Month
searls
217
42k
A better future with KSS
kneath
231
16k
Git: the NoSQL Database
bkeepers
PRO
423
63k
Done Done
chrislema
178
15k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
22
1.4k
Testing 201, or: Great Expectations
jmmastey
30
6.4k
What’s in a name? Adding method to the madness
productmarketing
PRO
17
2.7k
GitHub's CSS Performance
jonrohan
1025
450k
Code Reviewing Like a Champion
maltzj
515
39k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
smashingmag
245
20k
Transcript
HTTP API Design for iOS Applications
@vanstee Big Nerd Ranch
• Modeling Resources • Tools: Server and Client • Real
world problems • Future
Modeling Resources
The key abstraction of information in REST is a resource.
re·source /ˈrēˌsôrs/ A resource is a conceptual mapping to a
set of entities, not the entity that corresponds to the mapping at any particular point in time.
Resources are not just database records
Resources are the nouns. HTTP methods are the verbs. URIs
are the identifiers. Media types are the representations.
But what about transactions? searches? complex actions?
Don’t do this: POST /accounts/1/transfer/500.00/to/2 Try this instead: POST /transactions
{ “from”: 1, “to”: 2, “amount”: 500.00 }
Tools
Server-side • Rails • Active Model Serializers • Custom Responders
• rack-test and json_spec
Client-side • AFNetworking • RestKit (if you really need it)
• VCRURLConnection and mitmproxy
Real World Problems
Versioning Don’t do this: POST /v1/users/1 Try this instead: POST
/users/1 Accept: application/json; version=1.0
Authentication • OAuth2 with API routes for token generation •
NSURLConnection supports cookies • Basic Authentication over HTTPS*
Caching • NSURLCache has support for Cache-Control and ETags •
AFNetworking supports this by default • Rails gives you these for free
Smarter Requests • Side loading associated resources • HTTP Pipelining
for GET, HEAD, PUT, and DELETE requests • HTTP compression
Future
HTTP 2.0 • Based on SPDY • Multiplexing • Server
Push • Better compression
JSON API • Standard hypermedia type • Always namespaced •
Always returns collections for easy parsing • Support for batch operations
JSON Patch • Standard hypermedia type for updating records •
Easily handle associations • Send minimal amount of information
Thanks blog.steveklabnik.com designinghypermediaapis.com afnetworking.com jsonapi.org