REST basics

Nouns in the path, verbs in the method. GET must be safe and cacheable, PUT/DELETE idempotent, POST neither.

#rest#api#http#design

text

GET    /articles          list
GET    /articles/:id      read one
POST   /articles          create        -> 201 + Location
PUT    /articles/:id      full replace  (idempotent)
PATCH  /articles/:id      partial update
DELETE /articles/:id      remove        -> 204

Paginate:  /articles?page=2&limit=20
Filter:    /articles?tag=css&sort=-createdAt

HTTP status codes worth memorizing

2xx succeeded, 3xx go elsewhere, 4xx the caller is wrong, 5xx the server is wrong. These are the ones that come up in real APIs.

HTTP headers that matter

Caching and content negotiation live in headers. `Cache-Control` decides whether your CDN does any work at all.

REST basics

Related

HTTP status codes worth memorizing

HTTP headers that matter