各位富豪,你们的接口文档能不能认真点?

作者:vkvi 来源:ITPOW(原创) 日期:2018-5-25

腾讯、阿里的接口文档,可以说相当的不靠谱,网友用一个字来形容就是:坑。

  • 一是有错误,拼写错误,方法应用错误等。
  • 二是过时,比如 Framework 版本已经升级,方法已经调整,但是文档不调整。
  • 三是不全面,要执行一件事情,本应提供全部代码方便使用者了解,可是它只夹一小段代码,剩下的让用户去猜。
  • 四是乱,这个最严重,这里说一点,那里说一点,再有接口本身就比较坑,比如阿里有一个签名,要求在 key 后面追加 &,本身这种设计就比较奇葩,而有些地方又不追加,文档又不说清楚。

我们以微信这个文档为例:nonce_str、noncestr、nonceStr,三种写法,你们公司没有命名规范吗??还有商户号也有两种写法。

各位富豪,你们的接口文档能不能认真点?

 

各位富豪,你们的接口文档能不能认真点?

 

各位富豪,你们的接口文档能不能认真点?

 

相关文章