镜头的奥秘《分镜头脚本创作》
《分镜头脚本创作》带你一起探寻镜头中的世界。...
2023-06-11
编辑导读:为了方便开发和产品沟通,便有了接口文档。接口文档大多时候是给开发看的,那么产品为什么要会看接口文档呢?本文作者对此发表了自己的看法,一起来看看吧。 又到了周末,快乐开黑开始!阿宅兴冲冲得找小伙伴上号,结果小伙伴尔康摆手:“等一下,我先开电脑喷下开发。” 阿宅一局酣战之后,又来找到小伙伴:“好了没?”“没好,我被开发喷了,是我的需求bug,老板还骂我了,你看。” 为了让小伙伴尽快上号,我们开始一起复盘:“这是关于基金购买流程的需求,我在这个地方需要先明确基金的委托类型,我问爷爷找爸爸终于把这个理清楚了,可以分为购买、赎回、定投。结果上线后才发现分类没定义完整。”“这玩意不是接口里写得明明白白吗?” “!!!!接口文档是个啥!我怎么从来没看过!” “你啊你,都做了半年理财产品了,竟然连这个都不知道。那本宅就大发慈悲教教你吧,记住明天给我一根冰糖葫芦。” 一、什么是接口文档? 首先,什么是接口?你可以把它简单理解为一个函数,你输入x,它就会告诉你y。你无需知道这个函数的逻辑,只需要知道输入什么样的问题,会得到什么样的答案就可以了。 但x怎么输,会出现什么样的y,就需要通过接口文档来了解。就比如下图的表格,当你按照“输入参数”输入“委托方式”、“分支机构”等参数时,这个接口就会告诉你“资产账户”是什么。 恒生统一接入平台_周边接口规范(期货,期权_20210812).xls 二、产品为什么要能看懂接口文档? 接口一般来讲分为两种: 这便意味着开发的人甚至团队都不一样,为了便于沟通,便有了接口文档。从这里可以看出,接口文档大多时候是给开发看的,那么产品为什么要会看这玩意呢? 首先,在迭代或依赖其他系统时,你能明确知道有哪些资源。例如下面这个关于微信菜单创建的接口,从这个接口的参数“type”的说明,我们就能清楚的知道,微信菜单能实现3种交互:一是直接点击打开网页;二是消息推送;三是跳转小程序。 其次,业务很复杂的时候可以通过接口反推,例如我们在做期货需求时,不清楚期货产品分为哪些,这时我们便可以找到恒生的接口查查它的数据字典,结果就发现答案竟如此清晰: 再次,在写需求文档或和开发沟通发现说不明白时,也可以通过文档来澄清。例如做内容排序时可能有多个时间:创建时间、更新时间、操作时间等等。而你想调用的时间和开发理解的可能会存在差异,这时你便可拉出接口文档告诉他我要的就是CreateTime。 当然啦,接口文档还有很多妙用,比如作为撕逼利器、装逼神器等等,欢迎大家在留言区写下你的文档故事~ 三、接口文档怎么看? 接口文档有这么多好处,那我们怎么去读懂它呢?在这里我们用微信订阅通知的接口文档作为学习材料。 如上图所示,接口通常分为四部分:请求方法、url、请求参数、返回参数: 1)请求方法:常用的方法就是下面的四种——GET、PUT、POST、DELETE。 这个概念产品经理简单了解即可,一般不考 2)url:以微信微信订阅通知接口的url为例https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN 我们可以把这个 URL 分解成 5部分: 同样,产品经理不需要非常明白。 3)请求参数和返回参数:请求参数和返回参数都分为:字段、说明、类型、默认值、是否必填这5列。 字段:类的属性 说明:中文释义 类型:属性的类型,只有String、Number、Object、Array四大类 备注:一些解释语,或者写简单的示例 4)返回参数,要分两种情况讨论: 只返回接口调用成功或者失败:code、reason 返回参数:字段、说明、类型、默认值、是否必填 四、一些可供学习的网址 微信开放文档 https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html 金融交易统一接入平台 https://ufx.hs.net/ 高德地图API http://lbs.amap.com/api/jsapi-v2/summary 作者:阿宅的产品笔记;公众号:阿宅的产品笔记(PMZZnote) 本文由 @公众号阿宅的产品笔记 原创发布于人人都是产品经理。未经许可,禁止转载 题图来自Unsplash,基于CC0协议
以上内容就是为大家推荐的qq留言怎么全部删除(产品必修课:接口文档怎么用)最佳回答,如果还想搜索其他问题,请收藏本网站或点击搜索更多问题
内容来源于网络仅供参考版权声明:所有来源标注为小樱知识网www.cnfyy.com的内容版权均为本站所有,若您需要引用、转载,只需要注明来源及原文链接即可。
本文标题:qq留言怎么全部删除(产品必修课:接口文档怎么用)
本文地址:https://www.cnfyy.com/smjd/852097.html
相关文章
热点文章
2021年独生子女补贴新政策是真的吗(独生子女证有有效期吗)
2021年国庆节阅兵仪式几点开始几点结束(2021年国庆节还有阅兵吗)
鼠目寸光一点红是什么生肖动物(鼠目寸光一点红)指什么生肖,紧密
k0到k9的玩法大全(强制gc的玩法和注意事项)
入土为安是什么生肖《入土为安》打一个生肖动物,词语解释
浙江12月底全面停工是真的吗(浙江什么时候放假停工)
如何做t(t怎么把p做哭)
北京口碑最差的三甲医院(北京301医院最擅长什么)