پکیج Laravel REST API Response Builder
پکیج Laravel REST API Response Builder
REST API Response Builder for Laravel بسته ای است که توسط Marcin Orlowski برای ساخت پاسخ های JSON API ساخته شده است. به گفته نویسنده ، این بسته به شما در مواردی مانند تبدیل داده ها و بومی سازی اطلاعات کمک می کند:
ResponseBuilder برای توسعه دهندگان REST API توسط توسعه دهنده REST API نوشته شده است و مبتنی بر تجربه ماندگار من در هر دو طرف “طرف” (API و مصرف کننده API) انواع API های REST است. سبک وزن ، با روشهای ساده برای استفاده عمومی ، پوشش چندین مورد از موارد بالقوه استفاده ، تبدیل داده ها در پرواز ، پشتیبانی از محلی سازی ، ساخت پیام خودکار خطا ، پشتیبانی از API های زنجیر شده و مستندات جامع (امیدوارم).
ساده ترین مثال ارائه شده توسط این بسته ، برگرداندن موارد زیر از یک کنترلر است:
|
1 |
return ResponseBuilder::success(); |
کاربر حاصل JSON به شرح زیر خواهد بود:
|
1 2 3 4 5 6 7 |
{ “success”: true, “code”: 0, “locale”: “en”, “message”: “OK”, “data”: null } |
اگر می خواهید برای خطاهای متداول در API خود کدهای پیام ایجاد کنید ، می توانید موارد زیر را انجام دهید:
|
1 |
return ResponseBuilder::error(MyErrorCodes::SOME_CODE); |
اگر کد ۲۰۵ را تصویب کنید به پیام زیر می رسد:
|
1 2 3 4 5 6 7 |
{ “success”: false, “code”: 250, “locale”: “en”, “message”: “Your error message for code 250”, “data”: null } |
برای نمونه های بیشتر درباره آنچه این بسته ارائه می دهد ، مستندات دقیق را بررسی کنید. می توانید در مورد این بسته اطلاعات بیشتری کسب کنید ، دستورالعمل های کامل نصب را دریافت کنید و کد منبع را در GitHub در صفحه MarcinOrlowski/laravel-api-response-builder سازنده مشاهده کنید.
همچنین میتوانید از هاست توسعه دهنده ها برای راه اندازه پروژه های لاراول خود استفاده کنید