api response

CoreJsonResponse

CoreJsonResponse JSON-Antwortmerkmal. Diese Eigenschaft erleichtert es jedem Controller, eine JSON-Antwort mit dem entsprechenden HTTP-Statuscode zurückzugeben.

Über Composer installieren

 composer require aelnemr/api-response

Verwendung

Sie müssen lediglich das CoreJsonResponse Merkmal in Ihrem Controller use .

Beispiel:

 <?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 );
    }
}

Verfügbare Methoden

Erfolgsmethoden ✌️

Verfahren	Statuscode	Beschreibung
OK	200	Erfolgreicher Abruf, Patch (ein JSON-Objekt zurückgeben)
okWithPagination	200	Erfolgreicher Abruf, Patch (ein JSON-Objekt zurückgeben)
erstellt	201	Erfolgreicher Beitrag (ein JSON-Objekt zurückgeben)

Fehlerstatus?

Verfahren	Statuscode	Beschreibung
nicht authentifiziert	401	Fehler Nicht authentifiziert
verboten	403	Fehler Nicht autorisiert (Authentifiziert, aber keine Berechtigungen)
nicht gefunden	404	Fehler nicht gefunden
invalidRequest	422	Fehlervalidierung

Zusätzliche Methoden?

Verfahren	Statuscode	Beschreibung
akzeptiert	202	Erfolgreicher Beitrag, Löschung, Pfad – asynchron
Ungültige Anforderung	400	Fehler Die Anfrage konnte vom Server aufgrund einer fehlerhaften Syntax nicht verstanden werden
Zahlung erforderlich	402	Fehler Zahlung erforderlich
Konflikt	409	Fehler Logischer Fehler