1. 程式人生 > >API設計的十大最差和五大最佳實踐

API設計的十大最差和五大最佳實踐

那麼作為開發者,除了要學會呼叫API外,是否想過設計自己的API呢?這不,國外媒體給大家總結了10條最差API實踐開發API的五個最佳實踐,希望各位能在以後的開發道路上少走一些彎路。

十大最差實踐

  1. 錯誤處理不完善或者比較差
  2. Rest API忽視HTTP規則
  3. 暴露原始底層資料模型
  4. 安全複雜性
  5. 意外和非法釋出
  6. 缺乏開發經驗
  7. 期待一個MVC架構帶給你一個偉大的API
  8. 假設你構建API,使用者就會被引進來(Assume if you build it they will come)
  9. 技術支援不充分
  10. 文件不給力

你們在實際開發中有沒有過這些差勁做法呢?說實話,建立一個成功的API並非易事。除了總結錯誤的做法外,還有沒有一些更好地指導原則呢?John Musser在

OSCon上提煉了五個觀點,在此分享給大家。

五大最佳實踐

  1. 提供一個有價值的伺服器
  2. 有一個計劃和商務模型
  3. 簡單靈活
  4. 它應該被管理和測量
  5. 提供充足的技術支援

在這五個最佳實踐裡,最重要的是提供一個有價值的伺服器,如果你在一臺非常糟糕的服務上建立了一套非常偉大的API,那麼就相當於給豬塗口紅。