Aller au contenu
uencoder

JSON:API

JSON:API est une spécification de format de réponse d'API REST qui normalise objets ressource, relations, pagination et erreurs, réduisant la divergence de conception des API.

Objectif

Donner aux API REST une structure de réponse unifiée pour que les clients traitent ressources, relations et erreurs de façon générique.

Mécanisme

Les réponses contiennent data (tableau/objet de ressources), included (ressources liées chargées à part), meta et errors. Les objets ressource contiennent id, type, attributes et relationships ; les relations référencent links ou data.

Cas d’usage

  • Normaliser les réponses d'API REST
  • Contrats de données front-back
  • Pagination et chargement composé

Outils associés

References