移动API设计

Question

我们正在为移动应用程序和服务器之间的通信设计API。我们选择Json作为协议。我只是想知道命名策略。我们是否应该填写姓名或简称或全名？

1. measurementUnit，说明
2. msrUnit，递减
3. 亩，DSC

什么是你的最佳做法？

Answer 1

更具说明性的是，您可以让您的物业更有可能遇到潜在命名冲突和开发人员混淆的问题。

如果您决定公开零部件或全部API，这对您的消费者来说是自描述性的，这也很有用。

从中获得的好处将远远超出尝试缩短名称几个字符的带宽成本（除非您拥有不希望用于移动应用程序的MASSIVE有效载荷）。

命名实践明智我是camelCase的粉丝，你已经在做，并且再次提供描述性的属性名称。但我一直在努力放在一起的其他最佳API设计实践的集合 - 希望他们帮助 - 并随时与任何其他问题达成了：

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

谢谢， 迈克