Laravel REST API 響應生成器
阿新 • • 發佈:2019-12-31
文章轉發自專業的Laravel開發者社群,原始連結:learnku.com/laravel/t/3…
用於Laravel的REST API 響應生成器是 Marcin Orlowski的一個軟體包,用來構建JSON API響應。根據作者的說法,該軟體包可幫助您進行資料轉換和本地化等工作:
ResponseBuilder 是由 REST API 開發人員為那些 REST API 開發者而編寫的擴充套件包,它基於我對各種 REST API 開發「雙方」(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”: 205,“message”: “Your error message for code 250”,“data”: null
}
複製程式碼
查閱詳情 檔案 有關這個包的更多案例,你可以瞭解這個包的更多資訊,獲取完整的安裝說明,並在 GitHub 上檢視原始碼 MarcinOrlowski/laravel-api-response-builder.