Articles

Las colecciones son listados de recursos. En un sitio desacoplado (decoupled), se utilizan para crear cosas como una lista de “Nuevo Contenido” o una sección de “Mi contenido” en el lado del cliente.
Sin embargo, cuando realizas una solicitud sin filtros a un endpoint de colección como /jsonapi/node/article
, simplemente obtendrás todos los artículos a los que tienes permiso de ver.


TL;DR: Utiliza una cadena de consulta como ?include=field_comments.uid
para incluir todas las entidades referenciadas por field_comments
y todas las entidades referenciadas por uid
en esas entidades.
JSON:API te ayuda a eliminar solicitudes HTTP permitiéndote especificar rutas de relaciones que deseas incluir en el documento de respuesta. ¿Cómo?


La paginación puede ser un tema sorprendentemente complejo. Es fácil caer en trampas y no seguir las mejores prácticas. Esta página te ayudará a hacer la paginación “correctamente”. Es decir, si lees y comprendes esta página, tu cliente será más robusto, preparado para el futuro y tu vida será más fácil a largo plazo.
Si solo debes recordar una cosa de esta guía, debería ser que no debes construir tus propias URLs de paginación.


JSON:API permite recuperar múltiples recursos en una sola solicitud; estas rutas se denominan rutas de "colección". Puedes obtener una colección de recursos enviando una solicitud GET a la ruta base del recurso, por ejemplo, GET /jsonapi/node/article
y no incluyendo un UUID. Por defecto, esto incluirá todos los recursos del tipo especificado.
El filtrado y el ordenamiento están disponibles por defecto en todos los recursos estándar.


El módulo JSON:API expone las revisiones de entidades como versiones de recursos, de una manera inspirada en la RFC5829: Tipos de relaciones de enlace para navegación de versiones simples entre recursos web.
Limitaciones actuales:


JSON:API admite una funcionalidad multilingüe muy sencilla. No soporta casos de uso avanzados.


Esta sección contiene ejemplos e información por tipo de solicitud: GET, POST, PATCH y DELETE.
Acerca de los ejemplos
Todos los ejemplos son ejemplos funcionales que puedes probar tanto en un navegador como en un cliente JSON (por ejemplo: Postman). Necesitas una instalación estándar de Drupal, varios nodos de tipo Artículo y el módulo JSON:API habilitado.


Esta página muestra ejemplos de varias solicitudes GET para el módulo JSON:API.
En todos los ejemplos a continuación, no se requieren encabezados de solicitud. No se requiere autenticación si los usuarios anónimos pueden acceder a las entidades de contenido. Para entidades de configuración como menús, consulta las últimas secciones.
Ten en cuenta que en todos los casos, cuando se necesita un id, siempre es el uuid de la entidad, no el id de la entidad.


Esta página muestra ejemplos de varias solicitudes POST para el módulo JSON:API.
Las solicitudes POST se utilizan para crear nuevos recursos. Si necesitas modificar recursos, debes utilizar PATCH.


Esta página muestra ejemplos de solicitudes PATCH para el módulo JSON:API.
Habilitar la operación de actualización
Visita /admin/config/services/jsonapi
y marca la opción "Aceptar todas las operaciones de crear, leer, actualizar y eliminar de JSON:API".
