Laravel REST API 響應生成器

文章轉發自專業的Laravel開發者社區,原始連接: https://learnku.com/laravel/t...

用於Laravel的REST API 響應生成器是 Marcin Orlowski的一個軟件包,用來構建JSON API響應。根據做者的說法,該軟件包可幫助您進行數據轉換和本地化等工做:laravel

ResponseBuilder 是由 REST API 開發人員爲那些 REST API 開發者而編寫的擴展包,它基於我對各類 REST API 開發「雙方」(API 開發人員和 API 消費者)的長期經驗。它的特色在於:輕量級,具備簡單易用的公共方法,涵蓋多個潛在的用例,即時的數據轉換,本地化的支持,自動錯誤信息的構建,對鏈式 API 的支持,以及(我但願如此) 詳盡的文檔。

這個包提供的最簡單的例子是從控制器中返回如下內容:git

return ResponseBuilder::success();

生成的客戶端JSON以下所示:github

{
  「success」: true,
  「code」: 0,
  「locale」: 「en」,
  「message」: 「OK」,
  「data」: null
}

若是你想要爲API中的常見錯誤構建消息代碼,則能夠執行如下操做:api

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

若是你傳遞了 205錯誤碼,則會顯示如下信息:ui

{
   「success」: false,
   「code」: 205,
   「locale」: 「en」,
   「message」: 「Your error message for code 250」,
   「data」: null
}

查閱詳情 文件 有關這個包的更多案例,你能夠了解這個包的更多信息,獲取完整的安裝說明,並在 GitHub 上查看源代碼 MarcinOrlowski/laravel-api-response-builder.spa

相關文章
相關標籤/搜索