用於返回布爾值的REST API設計

Question

我正在設計一個rest api，它將接受日期，如果該日期是假日或不是布爾格式，則返回該API。 url模式應該是什么？

GET <domainname>/holidays?date=<mmddyyy>

應該是這樣還是有更好的方法來設計url？

Answer 1

應該是這樣還是有更好的方法來設計url？

機器不在乎-URI只是一個標識符。 像變量名一樣，為了我們自己的利益，我們給它們提供易於閱讀的拼寫。

也就是說，如果您要使用類似

/a7c63fe6-ca28-4f21-9421-c9ca3df75658?yyyymmdd

然后，一切仍然應該工作。

使用application/x-www-form-urlencoded鍵/值對是一個不錯的選擇，因為HTML表單處理器了解如何構建這些URI，因此可以通過網頁使用/測試它們。

?date=<YYYY-MM-DD>

但是其他安排並沒有錯。 我們只是權衡取舍。

/holidays/date/<mmddyyy>

該拼寫使您可以通過相對引用有趣的事情。

假設您打算由客戶端創建這些URI，那么您將需要與URI模板規范一致的內容。

Randal Munroe強烈建議您鼓勵使用符合ISO-8601的日期拼寫。