Vai al contenuto
Miraat·dweb developer journey, reflected

Progettare un'API REST

Convenzioni di URL, metodi HTTP, status code, paginazione, errori. La API che gli altri amano usare.

Core 30 minuti Prerequisiti: Routing e MVC

Convenzioni

  • URL = nomi (sostantivi), no verbi: /api/skills, non /api/getSkills.
  • Metodi HTTP per le azioni: GET, POST, PATCH, DELETE.
  • Plurali per le collezioni, singolari per le sotto-risorse: /api/skills/42/resources.
  • Errori coerenti: { "error": "validation", "fields": { … } }.
  • Paginazione con cursori (?cursor=…&limit=20) o offset (?page=2).
  • Versioning in URL o header: /v1/skills, Accept-Version: 1.

Esempio minimo

GET    /v1/skills?roadmap=frontend     → 200, lista
POST   /v1/skills                      → 201, creato
PATCH  /v1/skills/42                   → 200, aggiornato
DELETE /v1/skills/42                   → 204, no content

Risorse consigliate