最佳的API最佳實踐：是否包含狀態

Question

例如，讓我說我有一個API，該API返回數組中具有固定狀態的多個對象。

[{status:good},...,{status:good}]

應用程序邏輯說，如果其中的每個對象的狀態為“良好”，則此數組為“良好”。 當然。

因此，現在我通過API JSON編碼返回該數組。 我是否應該將狀態直接插入API輸出中，就像這樣

{status:good, array:[{status:good},...,{status:good}]}

還是應該在客戶端執行

API設計時如何確定這種情況？ 有沒有類似的指導方針？ 我的意思是第一種方法更直觀，而第二種方法更便宜。

Answer 1

最重要的問題是您的API的用途是什么？ 通過添加額外的“摘要”狀態，您可以對數據進行非規范化，這本身就是一個巨大的話題。

如果可以幫助用戶並且優先考慮的是使您的API快速且易於使用，則將其包括在內，使該API易於使用，尤其是在可以減少重復調用的情況下。

如果優先考慮的是數據完整性和大量數據使用，而不是易用性，則不要包含摘要。