REST API最佳實踐:如何接受參數值列表作為輸入我們正在推出一個新的REST API,我想要一些關于如何格式化輸入參數的最佳實踐的社區意見:現在,我們的API非常以JSON為中心(僅返回JSON)。關于我們是否想要/需要返回XML的爭論是一個單獨的問題。由于我們的API輸出是以JSON為中心的,我們一直在走一條路,我們的輸入有點以JSON為中心,我一直在想這可能對某些人來說很方便,但總的來說很奇怪。例如,要獲得一些產品詳細信息,我們可以立即提取多個產品:http://our.api.com/Product?id=["101404","7267261"]我們應該簡化為:http://our.api.com/Product?id=101404,7267261或者有JSON輸入方便嗎?更多的痛苦?我們可能希望接受這兩種風格,但這種靈活性是否會導致更多的混亂和頭痛(可維護性,文檔等)?更復雜的情況是我們想要提供更復雜的輸入。例如,如果我們想在搜索上允許多個過濾器:http://our.api.com/Search?term=pumas&filters={"productType":["Clothing","Bags"],"color":["Black","Red"]}我們不一定要將過濾器類型(例如productType和顏色)作為請求名稱,如下所示:http://our.api.com/Search?term=pumas&productType=["Clothing","Bags"]&color=["Black","Red"]因為我們想要將所有過濾器輸入組合在一起。最后,這真的很重要嗎?可能有很多JSON實用程序,輸入類型并不重要。我知道我們的JavaScript客戶端對API進行AJAX調用可能會欣賞JSON輸入以使他們的生活更輕松。
- 3 回答
- 0 關注
- 1086 瀏覽
添加回答
舉報
0/150
提交
取消