api response

CoreJsonRéponse

Trait de réponse JSON CoreJsonResponse. Cette fonctionnalité permet à n'importe quel contrôleur de renvoyer facilement une réponse JSON avec le code d'état HTTP approprié.

Installer via composer

 composer require aelnemr/api-response

Usage

Tout ce dont vous avez besoin est d' use le trait CoreJsonResponse dans votre contrôleur.

Exemple:

 <?php
namespace App  Http  Controllers ;

use Illuminate  Http  Request ;
use AElnemr  RestFullResponse  CoreJsonResponse ;

class CountryController extends Controller
{
    use CoreJsonResponse;

    public function index ()
    {
        $ data =  App User:: get ();
        return $ this -> ok ( $ data );
    }
}

Méthodes disponibles

Méthodes de réussite ✌️

Méthode	Code d'état	Description
d'accord	200	Récupération réussie, patch (renvoie un objet JSON)
okAvecPagination	200	Récupération réussie, patch (renvoie un objet JSON)
créé	201	Publication réussie (renvoie un objet JSON)

Statut d'erreur ?

Méthode	Code d'état	Description
non authentifié	401	Erreur Non authentifié
interdit	403	Erreur Non autorisé (authentifié, mais aucune autorisation)
non trouvé	404	Erreur introuvable
demande invalide	422	Validation des erreurs

Méthodes supplémentaires ?

Méthode	Code d'état	Description
accepté	202	Publication réussie, suppression, chemin - asynchrone
mauvaise demande	400	Erreur La requête n'a pas pu être comprise par le serveur en raison d'une syntaxe mal formée
paiementObligatoire	402	Erreur Paiement requis
conflit	409	Erreur Erreur logique