API Design


Idempotent
- Idempotent key
stateless


Rest(Http) API Design
Hackable, intuitive url
Service health check APIs
Caching
Time-based cache headers
Conditional cache headers
- ETag and If-Modified-Since, If-None-Match
- request.evaluatePreconditions(tag)
Add X-Request-ID to request
Versioning
- Accept: application/json; version=3

Rate limit
Security, Auth
Audit

Use plural noun
GET /api/dogs/{id}
GET /api/dogs/?name=xxx

Relationship
/{relationship-name}[/{resource-id}]/…/{relationship-name}[/{resource-id}]
GET /persons/1/dogs

Query
GET /persons;id=1/dogs GET /persons;name=blabla/dogs
GET /dogs?color=red&state=running&location=park

Partial Fields
/dogs?fields=name,color,location

Actions
/resources/:resource/actions/:action

"kind": "Dog"
"ownerID": "98765432",
"kind": "Collection",

hypermedia - HATEOAS
"ownerLink": "https://dogtracker.com/persons/98765432"
selfLink
"self": "https://dogtracker.com/dogs?limit=25,offset=0",
"kind": "Page",
"pageOf": "https://dogtracker.com/dogs",
"next": "https://dogtracker.com/dogs?limit=25,offset=25",

201 Created
301 Moved Permanently
304 Not Modified
401 Unauthorized
403 Forbidden

Resources
Heroku's HTTP API Design Guide

Labels

adsense (5) Algorithm (69) Algorithm Series (35) Android (4) ANT (6) bat (8) Become a Better You (4) Big Data (7) Blogger (14) Bugs (4) Cache (5) Chrome (17) Code Example (29) Code Quality (6) Coding Skills (5) Concurrency (4) Database (7) Debug (16) Design (5) Dev Tips (62) Eclipse (32) GAE (4) Git (5) Good Programming Practices (4) Google (27) Guava (7) How to (9) Http Client (8) IDE (6) Interview (88) J2EE (13) J2SE (49) Jackson (4) Java (177) JavaScript (27) JSON (7) Learning code (9) Lesson Learned (6) Linux (22) Lucene-Solr (112) Mac (10) Maven (8) Memory Usage (4) Network (9) Nutch2 (18) OpenNLP (4) Performance (9) PowerShell (11) Problem Solving (11) Programmer Skills (6) regex (5) Review (4) Scala (6) Security (9) Soft Skills (38) Spark (4) Spring (22) System Design (11) Testing (6) Text Mining (14) Tips (12) Tools (24) Troubleshooting (29) UIMA (9) Web Development (19) Windows (21) xml (5)

Trending