API設計 - JSON或URL參數？

Question

我剛開始學習如何設計/編寫RESTful API。我有一個普遍的問題：

假設我有某種簡單的SQL數據庫，我正在寫一個API，允許創建一個新的記錄，查看記錄，刪除記錄或更新記錄。

假設我想刪除一條記錄，是通常最好在URL中記錄的ID通過，例如，/api/delete_record?id=10，或者是它更好地做一些事情，如：

/api/record，並把它接受GET,POST,PATCH和DELETE，並且通過請求中的JSON正文處理數據。

我已經在Python中使用Flask編寫了一個小API，我所擁有的只是一個URL：/record它接受所有上述HTTP方法。它查看請求中的方法，並相應地預計JSON中的請求正文。這被認爲是好的或不好的做法？

任何建議將不勝感激。請注意，我對這一切仍然很陌生。我以前使用過API，但是我從未開發過任何API。謝謝！

Answer 1

正確的REST式刪除資源的方式是發送DELETE請求，並將作用域信息放在URI（而不是正文）中，如/api/records?id=10或/api/records/10。方法信息應該在HTTP方法中，而不是URI。

我建議你閱讀「REST風格的Web服務」來學習API設計的最佳實踐。