api response

CoreJsonResponse

سمة استجابة CoreJsonResponse JSON. تسهل هذه السمة على أي وحدة تحكم إرجاع استجابة JSON برمز حالة HTTP المناسب.

التثبيت عبر الملحن

 composer require aelnemr/api-response

الاستخدام

كل ما تحتاجه هو use سمة CoreJsonResponse داخل وحدة التحكم الخاصة بك.

مثال:

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

الطرق المتاحة

طرق النجاح ✌️

طريقة	رمز الحالة	وصف
نعم	200	تم الحصول على التصحيح بنجاح (إرجاع كائن JSON)
okWithPagination	200	تم الحصول على التصحيح بنجاح (إرجاع كائن JSON)
مخلوق	201	مشاركة ناجحة (إرجاع كائن JSON)

حالة الخطأ؟

طريقة	رمز الحالة	وصف
غير مصادق عليه	401	خطأ لم تتم المصادقة عليه
مُحرَّم	403	خطأ غير مصرح به (تمت المصادقة، ولكن لا توجد أذونات)
notFound	404	لم يتم العثور على خطأ
طلب غير صالح	422	التحقق من الخطأ

طرق اضافية؟

طريقة	رمز الحالة	وصف
مقبول	202	مشاركة ناجحة، حذف، المسار - غير متزامن
اقتراح غير جيد	400	خطأ تعذر على الخادم فهم الطلب بسبب صياغة غير صحيحة
مطلوب الدفع	402	مطلوب دفع خطأ
صراع	409	خطأ منطقي