什麼是學習如何編寫API的好方法？

Question

我們的團隊希望爲我們的網站編寫一個API - 編寫安全且簡化的API的最佳指導原則是什麼？是否有優秀的API開發人員遵循的原則？

Answer 1

我相信Web API設計的方法。它非常適合模型 - 視圖 - 控制器應用程序風格，它歸結爲這個非常簡單的想法：完全按照設計使用的HTTP使用HTTP。

Answer 2

不知道任何語言，領域，目標等，我的建議將是相當通用的。但是...

• 避免爲用戶做太多事情。如果你爲他們做了太多的事情，你可以經常阻止他們以你沒有想到的方式使用API​​，但它們完全可以接受。
• 返回有用的錯誤。我討厭使用API​​來返回諸如「錯誤代碼500 - 遇到的一般錯誤」之類的東西，以避免每一個錯誤。
• 吃自己的狗食。嘗試實際構建運行在API之上的應用程序，而不是僅僅進行一些單元和功能測試。