有奖活动:参与新版商家券文档调研点击反馈,赢取加速审核次数~
————————————
开发文档作为开发者与平台的初次握手,一直是开放平台重点优化对象。
最近,为提高接口文档理解效率,降低阅读门槛,我们对文档进行了结构与功能上的升级,主要包括以下几方面:
一、对接口分组;一图理解接口逻辑关系
过去,能力的对应接口都是瀑布一样流淌于文档中,开发者常常很难弄清其中的逻辑关系。对此,我们将接口以类型划分,让各接口作用更加清晰。例如,“商家券”接口就被分为了商家券活动、商家券、蚂蚁店铺、商家图片、商户类目五种类型。此外,我们通过uml类图将接口间的依赖字段进行可视化呈现,并与接口目录分组保持一致,希望加深大家对能力间逻辑关系的理解。
二、关键字段增加相关操作指引
对于部分关键字段,开发者该如何知道它的上下游关系?比如商家券的活动ID应该从哪里创建,在哪些场景中得到应用?现在,通过关键参数的鼠标悬浮窗卡片,开发者可查看该字段别名和关键操作,掌握其影响范围。
三、新增中文名;描述更清晰
现在,我们为接口参数配上了“中文名”,并且将描述分为不同“段落”,包括字段说明、注意事项和枚举值,每个段落“粒粒分明”。
目前,可通过以下链接体验到新版文档:
https://opendocs.alipay.com/open/03rz3g?ref=api
同时,我们也希望听到更多来自大家的文档建议(当然,吐槽也完全接受,我们内心很强大,承受得住)。以下为新版文档反馈的问卷二维码,或者点击反馈,我们将选出5位开发者,送上加速审核次数1次(需在反馈中填写账户PID),你的声音对我们很重要。
(支付宝扫码打开)