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。

我建議您閱讀“RESTful Web服務”以了解API設計的最佳實踐。