【有奖调研】开发文档功能升级:接口分组更清晰;增加参数中文名

简介: 【有奖调研】开发文档功能升级:接口分组更清晰;增加参数中文名

有奖活动:参与新版商家券文档调研点击反馈,赢取加速审核次数~


————————————


开发文档作为开发者与平台的初次握手,一直是开放平台重点优化对象。


最近,为提高接口文档理解效率,降低阅读门槛,我们对文档进行了结构与功能上的升级,主要包括以下几方面:


一、对接口分组;一图理解接口逻辑关系


过去,能力的对应接口都是瀑布一样流淌于文档中,开发者常常很难弄清其中的逻辑关系。对此,我们将接口以类型划分,让各接口作用更加清晰。例如,“商家券”接口就被分为了商家券活动、商家券、蚂蚁店铺、商家图片、商户类目五种类型。此外,我们通过uml类图将接口间的依赖字段进行可视化呈现,并与接口目录分组保持一致,希望加深大家对能力间逻辑关系的理解。



二、关键字段增加相关操作指引


对于部分关键字段,开发者该如何知道它的上下游关系?比如商家券的活动ID应该从哪里创建,在哪些场景中得到应用?现在,通过关键参数的鼠标悬浮窗卡片,开发者可查看该字段别名和关键操作,掌握其影响范围。



三、新增中文名;描述更清晰


现在,我们为接口参数配上了“中文名”,并且将描述分为不同“段落”,包括字段说明、注意事项和枚举值,每个段落“粒粒分明”。



目前,可通过以下链接体验到新版文档:


https://opendocs.alipay.com/open/03rz3g?ref=api


同时,我们也希望听到更多来自大家的文档建议(当然,吐槽也完全接受,我们内心很强大,承受得住)。以下为新版文档反馈的问卷二维码,或者点击反馈,我们将选出5位开发者,送上加速审核次数1次(需在反馈中填写账户PID),你的声音对我们很重要。


(支付宝扫码打开)

目录
相关文章
|
2月前
|
小程序 开发者
【产品上新】示例代码更清晰,开放平台文档功能更新!
【产品上新】示例代码更清晰,开放平台文档功能更新!
17 0
|
2月前
|
小程序 开发者
【社区每周】小程序商品能力两项接口变动(11月第三期)
【社区每周】小程序商品能力两项接口变动(11月第三期)
37 0
|
2月前
|
设计模式 小程序 安全
【社区每周】商家分账接入指南更新;基础库新增抽象节点功能及上周问题反馈(2月第二期)
【社区每周】商家分账接入指南更新;基础库新增抽象节点功能及上周问题反馈(2月第二期)
129 0
|
3月前
【突破常规:让函数规范成为注目的亮点】(上)
【突破常规:让函数规范成为注目的亮点】
|
3月前
【突破常规:让函数规范成为注目的亮点】(下)
【突破常规:让函数规范成为注目的亮点】
|
3月前
|
安全 前端开发 测试技术
【测开方法论】当老功能代码命名不规范的时候...如何安全增加新功能
【测开方法论】当老功能代码命名不规范的时候...如何安全增加新功能
|
7月前
|
存储 前端开发 安全
什么是盲盒游戏系统开发规则丨指南教程丨功能逻辑丨需求项目丨源码方案
确定盲盒游戏的目标受众、玩法要素和游戏规则。 - 确定游戏系统的核心功能,如盲盒的获取、开启、物品收集、交易等。 - 确定技术平台和开发语言,如移动端应用的开发是选择原生开发(如iOS的Swift或Android的Java/Kotlin)还是跨平台开发(如React Native或Flutter)。
|
8月前
|
前端开发 区块链
合成游戏看广告视频盒子系统开发方案逻辑/详细案例/功能设计/需求步骤/规则项目/源码说明
在Solidity中,与外部合约交互可以通过调用函数来完成。这些函数可以是在Solidity合约中定义的函数,也可以是在外部合约中定义的函数。调用外部合约函数需要知道合约的地址和函数的签名。
|
9月前
|
JSON 监控 API
php对接小鹅通API开发高级实战案例解析:获取指定资源学习记录信息(单人单学习记录、单人多学习记录累计、返回数据格式确认)
php对接小鹅通API开发高级实战案例解析:获取指定资源学习记录信息(单人单学习记录、单人多学习记录累计、返回数据格式确认)
195 0
合成进阶奖励模式系统开发搭建源码规则解析
合成进阶奖励模式系统开发搭建源码规则解析