REST Cheatsheet

REST Cheatsheet.md

REST Cheatshit

REST to CRUD

• POST - create
• GET - read
• PUT - update (replace)
• PATCH - update (partial)
• DELETE - delete
• HEAD - verify

Method-Safe-Idempotent

Method	Safe	Idempotent
GET	✅	✅
PUT	❎	✅
PATCH	❎	❎
DELETE	❎	✅
POST	❎	❎

REST Versioning

URL /api/v2/{uri} or header 'X-API-Version: 2.4'

Naming URI

• /notes - list
• /notes?filter="a" - list with attr
• /notes/1 - uri
• /notes/1?include_feature="a" - uri with attr

Using PATCH

Call PATCH with JSON payload with operation, field and optional value

Example:

{"operation": "replace", "field": "amount", "value": 200.12}

{"operation": "toggle", "field": "verified"}

{"operation": "increase", "field": "counter", "value": 12}