REST API url 濾波設計

Question

我一直在環顧四周，大多數人似乎建議在 REST API URL 中使用括號表示法設計過濾（例如/resource?weight[gte]=1&weight[lte]=5 ）或這個的一些變體......

但是有什么理由我們不能只使用分隔符並在 API 文檔中記錄預期的順序嗎？ 例如/resource?weight=1_5 ... API 文檔將通知客戶端模式為 min_max

以上兩者是否有任何優點或缺點可以保證兩者之間的關系？

Answer 1

以上兩者是否有任何優點或缺點可以保證兩者之間的關系？

是的。

首先： RFC 3986中的 URI 生產規則不允許在 URI 的查詢部分使用左方括號和右方括號 - 這些字符必須經過 pct 編碼。

第二：我們沒有一個很好的方法來將定制的查詢值分隔符傳遞給通用組件。 您在這里建議做的類似於對兩個值使用單個輸入控件 - 並告訴使用表單的人他們應該使用特定模式鍵入文本。 但是我們真的沒有一個標准化的語言。

在標准化URI 模板方面已經做了很多工作，您的默認選項應該限於那里描述的機制。 在代碼審查中，如果您沒有准備好令人信服的支持證據，我會反對您的提議。