sientifica/json-api-minimal

Minimal JSON:API serializer for arrays and object collections.

Maintainers

Package info

github.com/Sientifica/json-api-minimal

pkg:composer/sientifica/json-api-minimal

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Security

Advisories: 0

Aikido package health analysis

This package has no released version yet, and little information is available.

README

Paquete PHP mínimo para serializar arreglos o colecciones de objetos a strings JSON:API.

Instalación (Composer)

composer require mauricio/json-api-minimal

Requisitos

  • PHP 8.1+

Especificación mínima implementada

  • Documento JSON:API con clave raíz data.
  • Incluye meta a nivel raíz con el campo mínimo count.
  • Cada recurso incluye:
    • type (usa el parámetro $type o el type del item si existe).
    • id (obligatorio en cada item).
    • attributes (resto de campos del item, excluyendo id y type).
  • Soporta:
    • array de items.
    • Traversable (ejemplo: Collection, ArrayIterator).
    • cada item puede ser array, objeto con propiedades públicas, o JsonSerializable.

Uso

<?php

use JsonApiMinimal\JsonApiSerializer;

$serializer = new JsonApiSerializer();

$items = [
    ['id' => 1, 'name' => 'Ada', 'email' => 'ada@example.com'],
    ['id' => 2, 'name' => 'Grace', 'email' => 'grace@example.com'],
];

$json = $serializer->serializeCollection($items, 'users', [
    'source' => 'import-job',
    'request_id' => 'req-1001',
]);

echo $json;
// {"data":[{"type":"users","id":"1","attributes":{"name":"Ada","email":"ada@example.com"}},{"type":"users","id":"2","attributes":{"name":"Grace","email":"grace@example.com"}}],"meta":{"source":"import-job","request_id":"req-1001","count":2}}

API pública

  • serializeCollection(array|Traversable $items, string $type, array $meta = []): string
  • serializeItem(mixed $item, string $type, array $meta = []): string

Tests

composer install
composer test