در حال بارگزاری ...

استفاده از پکیج REST API Response Builder در لاراول

توسط الهه قنبری
آخرین به روز رسانی جمعه 16 خرداد 1399

در ادامه مقاله‌هایی که در آن‌ها به معرفی پکیج‌های لاراول و نحوه استفاده از آن‌ها می‌پردازیم، در مقاله امروز لیداوب نیز یکی دیگر از پکیج‌های کاربردی لاراول به نام REST API Response Builder را مورد بررسی قرار خواهیم داد. با ما همراه باشید.

REST API Response Builder پکیجی در لاراول است که توسط Marcin Orlowski به منظور ایجاد پاسخ‌های JSON API طراحی شده است. به گفته طراح این پکیج، می‌توان از آن در مواردی مانند تبدیل داده‌ها و بومی سازی اطلاعات استفاده کرد:

ResponseBuilder برای توسعه دهندگان REST API نوشته شده است. پکیج توسط توسعه دهندگان و کلاینت‌های API مورد استفاده قرار می‌گیرد و در مواردی مانند تبدیل داده‌ها، بومی سازی اطلاعات، ساخت پیغام‌های خطای خودکار، پشتیبانی از API‌های متوالی و مستندات جامع کاربرد دارد.

ساده ترین مثالی که توسط این پکیج ارائه شده است، برگرداندن موارد زیر از یک کنترلر است:

return ResponseBuilder::success();

کلاینت JSON حاصل به صورت زیر خواهد بود:

{
“success”: true,
“code”: 0,
“locale”: “en”,
“message”: “OK”,
“data”: null
}

اگر بخواهید برای خطاهای متداولی که در API رخ می‌دهد، کدهای پیغام خطا ایجاد کنید، می‌توانید به صورت زیر عمل کنید:

return ResponseBuilder::error(MyErrorCodes::SOME_CODE);

اگر کد 205 را انتقال دهید، منجر به صدور پیغام خطای زیر می‌شود:

{
“success”: false,
“code”: 250,
“locale”: “en”,
“message”: “Your error message for code 250”,
“data”: null
}

آشنایی با پکیج‌های بیشتر در لاراول:

برای کسب اطلاعات بیشتر در مورد امکاناتی که این پکیج در اختیار شما قرار می‌دهد، می‌توانید مستندات مربوط به آن را بررسی کنید. همچنین اطلاعات بیشتر در مورد دستورالعمل‌های کامل نصب و همچنین کد منبع این پکیج را می‌توانید در GitHub مشاهده کنید. با سایر مقالات ما در لیداوب همراه باشید.

 

دیدگاه ها

دیدگاه ها : 0


متاسفانه فقط اعضای سایت قادر به ثبت دیدگاه هستند

رایگان

اشتراک گذاری در
سورس خرید و فروش ارزهای دیجیتال
ثبت امتیاز
3 (2 رای)

   لطفا صبر کنید ...