Laravel 系列 - 5: 探討 API 實作細節

在這一單元中，我將統整實作 API 時需要注意的幾個關鍵細節，除了傳遞資料的規範外，還會提到與前端互動時常見的「小地雷」，幫助大家避免踩雷喔！

接收 Request

參數

$val = $this->input('message.url', '')

驗證

整理

當我們接收到 Request 時，除了直接取得資料，我們還可以將資料轉換成我們自定義的類別物件。這樣不僅能減少 Controller 層的程式碼量，還能提高整體可維護性。這樣的做法能讓其他工程師在處理這些資料時，不用再猜測陣列中的內容是什麼，從而提高開發效率和程式的可讀性。

處理 API

在處理 API 內部邏輯時，建議盡量使用 JSON、陣列（Array）或自訂類別的架構來傳遞資料。這樣不僅能提高資料傳遞的靈活性，也能方便在最終輸出時使用 toArray() 方法將資料轉換為陣列格式。

回傳 Response

一般來說，API 的正常回應會使用 HTTP 狀態碼 200，而當處理發生錯誤時則回傳 500。但如果我們只需要回傳處理成功的狀態，而不需要回傳實際內容時該如何處理呢？

不曉得大家還記不記得之前的文章：新手村導讀 - 4: HTTP 回應狀態碼。原則上，這時候我們可以回傳狀態碼 204，表示「無內容」，而 Laravel 提供了 noContent() 方法來輕鬆實現這一點：

return response()->noContent();

另外，還需要注意的是，回傳內容中的符號最好使用全形符號。這是因為在瀏覽器處理時，中文的半形符號容易丟失，尤其是空格。

隨著對 API 實作的理解加深，相信你將能夠在未來的專案中更加自信地處理各種挑戰。如果有任何問題或建議，歡迎在下方留言，讓我們一起討論與進步！

參考資料

1. https://laravel.com/docs/10.x/validation#available-validation-rules
2. https://stackoverflow.com/questions/6243051/how-to-pass-an-array-within-a-query-string