進階 RESTful API 討論

複習一下！並加入比較深入進階的部分，利用鐵人賽這個機會讓我再去認真查詢學習 RESTful API 的相關設計！雖然不是強制一定要這麼設計API，但是可以讓程式碼的可讀性更好！我想這是各位大大會想努力的地方。

確認一個資源

如之前的範例資源就是動物資源，設計RESTful API要先有一個客戶端資源，可以做查詢動物的資訊、建立、編輯、刪除，分別用HTTP不同的動詞，以客戶端(介接我們API的人)的方向去思考，不需要跟資料表一模一樣。

HTTP 動詞

  • GET: 讀取資源
  • POST: 新增資源
  • PUT: 替換資源
  • DELETE: 刪除資源
  • PATCH: 更新資源部份內容

GET 的動作相較安全，它不會變動更改到伺服器的資訊，主要用來查詢資料。

POST、DELETE、PATCH、PUT 則會依照對應的動詞做需要的動作，寫入資料庫，或一些商業邏輯。

一定會是這種模式 動詞+資源

POST http://127.0.0.1/animal

PUT、PATCH 差別

PUT 通常做替換一個資源功能。

PATCH 修改資源的部分內容。

我自己是這麼定義的，假設資料表內已經有一筆資料內容如下

{
  "id" : 1,
  "name" : "小白" ,
  "type" : "小型犬" ,
  "birthday" : "2019/1/29"
}

PUT ： 動物資料整個替換掉 PUT 方式請求網址 /animals/1  修改編號1的資料，回傳資料內容都是ID 1但裡面的內容整個不同。

PUT下面的內容，那麼ID 1的資料就會全部被修改成小黑的資訊，所以請求的時候必須填寫所有欄位不然資料會變成預設值。 

{
  "name":"小黑" ,
  "type":"大型犬",
}

--結果--
{
  "id" : 1,
  "name" : "小黑" ,
  "type" : "大型犬" ,
  "birthday" : null
}
閱讀更多

我的最愛追蹤功能製作

定義資源

我的最愛功能，製作一個可以讓 user 追蹤動物的操作，是一個連結的關係，綁定動物與用戶的關聯。

依照以前的經驗，我會幫這樣的動作取一個名字 like 之類的資料表來儲存內容。

但經過幾次的打造API經驗後，在規劃資料表的命名上，如果系統規模很大只有 like 當表名不是很明確。

我們這個系列打造的送養系統如果想要新增一個追蹤某位愛心媽媽的功能，就會覺得like不是很明確。

這樣在資料庫中看到 like 資料表，無法明確的知道內容。所以這邊我不另外給它一個名字。

會製作一張表  animal_user  這是我目前的原則！可以清楚知道這張資料表紀錄著 animal 與 user 的關係，並且依照字母排列A->Z命名這張表。 所以不命名為 user_animal 這是開始用 Laravel 後才有的習慣，在某個官方文章有寫到預設是 開頭A->Z來建立資料表。

閱讀更多

資料表設計規則-命名規則

之前有提到過小弟我是在開發WEB的工程師，經過幾次的案子會發現，注意一些小細節，建立好一個原則，對於大型的專案有很大的幫助。一開始可能覺得很麻煩，就跟後端程式碼的Coding Style一樣，縮排要空幾格、逗號之後空一格、名稱格式…感覺沒什麼用，資料庫也是一樣，如果隨便命名資料表，依照當下心情去決定，或是不想設定條件約束，設定後礙手礙腳，不好操作。

不過只要知道原理，以及命名有一個原則，等到有非常多資料表在資料庫中時，就會感受到這些小細節帶給你的好處！

閱讀更多

會員權限設計(管理員、一般會員)

昨天設定修改資料表以符合需求，接下來要設定權限部分，打算分兩種會員 管理員與一般會員。

權限說明
管理員可以做所有的新增刪除修改
一般會員可以新增動物而已，並且只能修改自己新增的動物。無法新增刪除修改分類

新建一個原則 policy

php artisan make:policy AnimalPolicy -m Animal
產生policy檔案
閱讀更多

JOIN 介紹

今天來介紹JOIN，有以下幾個模式！

  1. JOIN
  2. LEFT JOIN
  3. RIGHT JOIN
  4. FULL OUTER JOIN
  5. CROSS JOIN
SELECT aga.area_pkid, a.name, aga.subid, aga.place, aga.kind 
FROM adoption_gov_animals AS aga LEFT JOIN areas AS a 
ON aga.area_pkid = a.id;
閱讀更多

修改資料表新建 migration

明天我們要來建立權限的部分，之前設定的是驗證使用者使用 token 身份，但一班的網站至少會有管理員或一般會員的區分，因此今天先來修改基本需要設定的東西。

變更資料表

資料表原本規劃時沒注意到的地方，或是規劃好的東西難免都會被要求修改需求，所以修改資料表也是一門學問，用 migration 檔案修改檔案可以方便整個團隊更新到最新的版本。

跟大家說一個經驗，如果目前的系統是在線上用運行中的，並且公司沒有 DBA 在負責管理資料庫的話，要變更資料庫欄位時一定要三思而後行。 至少要確認有沒有備份。

閱讀更多

JOIN 資料表的結合

為什麼拆開了！又要結合～你真的很野小，雖然只是把地區編號不重複的查詢出來，並補上資料，拆成areas 資料表，感覺起來好像沒有什麼，但是如果去拆分csv原始檔 後面的 動物所屬收容所代碼名稱，就會感受到拆解出來可以結審很多空間。

但在拆解後面的資料前，我們先嘗試把兩張資料表結合再一起吧！雖然是結合起來，但並不是真的合成一張表，是用 JOIN這個陳述，查詢出來並不是建立一個資料表

閱讀更多

OAuth2 認證機制 Token 原理

簡單說要做任何需要認證的請求時。例如（我「想」要新增動物）那麼就要先跟伺服器請求核發一組 Access Token(就是一段亂碼)。把這個 Token 附帶在請求中，就可以操作需要驗證的API (我要新增動物-附帶有效的Token)

Passport 是一個官方推薦的套件，可以輕鬆簡單的讓你完成一個完善的 OAuth2 認證機制！

(這裡指的是否登入的感覺，不是權限角色的分組)

順帶一提，Passport Laravel版本必須要大於 5.3 才能使用。

閱讀更多