听闻微信开发者文档很差

2021-10-28 10:10:20 +08:00
 anzu
实际试过之后才知道有多烂
1. 命名风格不统一
同一个接口,一个字段命名为 xxxid ,另一个为 xxx_id 。大概他们自己也觉得蠢,在下一个版本的接口中统一为 xxxid 。

2. 描述不清
一个字段描述是需要随机字符串,没有说明任何字符限制。按照字面理解,我传 random ascii ,结果错!只好老实按照他给的示例值 字母 + 数字 生成,至今不知道是不是做了这个字符限制,懒得再试其它字符。

3. 描述不清 2
接口需要传 json ,有的字段标注非必填。按照我的理解,非必填那就传 null ,结果错!人家的意思是连字段名都不传。不知道他们用的什么开发,是不是很难兼容两种情况,反正我的项目是能轻易兼容的。

总的来说也不是什么大问题,但是总在不应该有的小问题上给你整活儿就很讨厌。
6798 次点击
所在节点    微信
68 条回复
pkoukk
2021-10-29 09:44:03 +08:00
还行吧,我的要求不高,示例跑的通就行
hzder
2021-10-29 10:20:26 +08:00
最近刚对接过微信。。确实烂,妈的
lwldcr
2021-10-29 10:20:44 +08:00
大家都一样烂 就不要比较了

我项目里用到的字节的巨量引擎文档
* 字段类型标注里整数型用到了```number```,```int```,老老实实写个 int/int32/int64 能死,你项目后端本身不就是 go 实现的,用 go 的类型定义不就行了
* 还是类型说明,对于嵌套类型,有些直接写个```json```,, 有些直接写个```json[]```,还有些写的是```object```, ```object[]```

一开始还想反馈一下纠错的,后来发现太多了就懒得弄了,所有整数型直接```int64```,所有自定义类型直接按全字段定义
skinny
2021-10-29 10:49:26 +08:00
烂,各种返回描述含糊不清,甚至压根没有,让你实际执行再去看返回,然而你测试也需要先申请相关服务,没法根据文档直接开写,你即便申请好了相关服务,因为文档烂,你还是得搜索别人的代码看别人踩过的坑,不然你不小心就运行不了。 还有各种数据长度大小限制也不说,言辞之间好像随时会变,实际又很多年没有变,设计数据库时写个列限制都没法写。
skinny
2021-10-29 10:51:20 +08:00
还有有的字段到底可以填什么也不写清楚,同一个 API 不同页面的说法不一样,还得看别人踩过的坑才能知道到底怎么写。
anzu
2021-10-29 11:00:50 +08:00
又发现一个,同一个字段在不同接口的长度限制不一样...我暂且取交集得了
legiorange
2021-10-29 11:02:05 +08:00
被微信支付和微信小程序文档劝退,已完全放弃微信端开发……
lskjdfgl
2021-11-02 09:51:40 +08:00
还有一个,也不知道那个王八蛋写的 [字符串] 不适用于汉字

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/811162

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX