⼤⼚对外提供的API接⼝⼊参命名规范
最近查阅百度API接⼝时,发现接⼝⽂档中,参数明⽂居然是下划线格式,很疑惑。进⼀步查阅了 阿⾥开发平台、腾讯开发者平台,对外api接⼝都是下划线命名, 为什么? java实体类的属性⼀般是遵从驼峰式命名规范。我们的程序⾥的数据访问层⼀般均采⽤ORM框架。如果表字段是⼩写字母+下划线,那么,相应的POJO/POCO实体类的属性也会是⼩写字母+下划线,这样,违背了驼峰式命名规范,有违代码的整洁度。
在⽹上查阅到原因:
对外提供的接⼝,
如果⽤驼峰式。 ⾸先,我们⽤word编写接⼝说明⽂档时,在参数表格列⾥输⼊参数名后,如果按tab键,则word默认⾸字母是⼤写的。⽽如果恰好我们的⾸字母是⼩写时,如果我们在编写时忽略了这个细节,这就会给对接者带来疑惑(产品设计上有⼀条重要的原则:Don't Make Me Think,同样适⽤于软件设计); 更甚之,如果签名规则要求的签名原串包括参数名时,那么,因字母⼤⼩写所致的验签失败往往不那么容易排查出来,进⽽造成双⽅的“不必要”沟通。
如果⽤⼩写+下划线。 ⾸先,这种⽅式规避了上⾯驼峰式命名的不⾜。 其次,考虑到商户对接存在不同的编程语⾔如php/java/,跨语⾔程序员之间也都会认可。
百度api接口综上:个⼈建议对于内部系统之间的接⼝,尽量采⽤java命名规范。 对外提供API可以和⼤⼚们保持⼀致。各有优缺点,看开发者如何取舍。 实践出真知。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论