v1.0.1

Response-formatter-api

Un utilitaire PHP léger pour le Framework Slim permettant de standardiser les réponses API au format JSON et XML.

Pourquoi l'utiliser ?

Par défaut, Slim Framework laisse au développeur la gestion manuelle du corps de la réponse et des en-têtes (headers). ResponseFormatterAPI simplifie ce processus en offrant une structure de réponse constante.

Format Standardisé : Structure identique pour tous vos endpoints.
Multi-format : Basculez entre JSON et XML facilement.
PSR-7 : Compatible avec l'objet Response de Slim.

Installation

Installez le package via Composer pour une gestion automatique des dépendances :

composer require 913groups/response-formatter-api

Ou incluez directement la classe dans votre dossier src/Utils/. ou encore l'équivalence de ce dossier

Utilisation

Réponse JSON Standard

return ResponseFormatterAPI::JSON(
                    true,                // Succès (booléen)
                    "Utilisateur trouvé", // Message
                    200,                 // Code HTTP
                    $user,               // Données
                    $response            // Objet Response
                );

Réponse XML

return ResponseFormatterAPI::XML(
    true, 
    "Statistiques récupérées", 
    200, 
    $data, 
    $response
);

Structure des Réponses

Format JSON

{
  "success": true,
  "message": "Ok",
  "data": { "id": 1 }
}

Format XML

<response>
  <success>true</success>
  <message>Ok</message>
  <data>{"id":1}</data>
</response>

⚙️ Détails techniques

La classe automatise les tâches répétitives suivantes :

Encodage automatique : Gère le json_encode et la structure XML.
Headers HTTP : Définit le Content-Type adéquat automatiquement.
Code Statut : Applique le withStatus() pour respecter les standards REST.