2014-12-11 85 views
0

我們正在爲移動應用程序和服務器之間的通信設計API。我們選擇Json作爲協議。我只是想知道命名策略。我們是否應該填寫姓名或簡稱或全名?移動API設計

  1. measurementUnit,說明
  2. msrUnit,遞減
  3. 畝,DSC

什麼是你的最佳做法?

回答

1

更具說明性的是,您可以讓您的物業更有可能遇到潛在命名衝突和開發人員混淆的問題。

如果您決定公開零部件或全部API,這對您的消費者來說是自描述性的,這也很有用。

從中獲得的好處將遠遠超出嘗試縮短名稱幾個字符的帶寬成本(除非您擁有不希望用於移動應用程序的MASSIVE有效載荷)。

命名實踐明智我是camelCase的粉絲,你已經在做,並且再次提供描述性的屬性名稱。但我一直在努力放在一起的其他最佳API設計實踐的集合 - 希望他們幫助 - 並隨時與任何其他問題達成了:

http://blogs.mulesoft.org/api-best-practices-series-intro/

謝謝, 邁克