Saltar al contenido
uencoder

JSON:API

JSON:API es una especificación de formato de respuesta para APIs REST que estandariza objetos de recurso, relaciones, paginación y errores, reduciendo la divergencia de diseño de APIs.

Propósito

Dar a las APIs REST una estructura de respuesta unificada para que los clientes manejen recursos, relaciones y errores de forma genérica.

Mecanismo

Las respuestas contienen data (array/objeto de recursos), included (recursos relacionados precargados), meta y errors. Los objetos de recurso contienen id, type, attributes y relationships; las relaciones referencian links o data.

Casos de uso

  • Estandarizar respuestas de APIs REST
  • Contratos de datos frontend-backend
  • Paginación y carga compuesta

Herramientas relacionadas

References