编辑导读:为了方便开发和产品沟通,便有了接口文档。接口文档大多时候是给开发看的,那么产品为什么要会看接口文档呢?本文作者对此发表了自己的看法,一起来看看吧。
又到了周末,快乐开黑开始!阿宅兴冲冲得找小伙伴上号,结果小伙伴尔康摆手:“等一下,我先开电脑喷下开发。”
阿宅一局酣战之后,又来找到小伙伴:“好了没?”“没好,我被开发喷了,是我的需求bug,老板还骂我了,你看。”
为了让小伙伴尽快上号,我们开始一起复盘:“这是关于基金购买流程的需求,我在这个地方需要先明确基金的委托类型,我问爷爷找爸爸终于把这个理清楚了,可以分为购买、赎回、定投。结果上线后才发现分类没定义完整。”“这玩意不是接口里写得明明白白吗?”
“!!!!接口文档是个啥!我怎么从来没看过!”
“你啊你,都做了半年理财产品了,竟然连这个都不知道。那本宅就大发慈悲教教你吧,记住明天给我一根冰糖葫芦。”
一、什么是接口文档?首先,什么是接口?你可以把它简单理解为一个函数,你输入x,它就会告诉你y。你无需知道这个函数的逻辑,只需要知道输入什么样的问题,会得到什么样的答案就可以了。
但x怎么输,会出现什么样的y,就需要通过接口文档来了解。就比如下图的表格,当你按照“输入参数”输入“委托方式”、“分支机构”等参数时,这个接口就会告诉你“资产账户”是什么。
恒生统一接入平台_周边接口规范(期货,期权_20210812).xls
二、产品为什么要能看懂接口文档?接口一般来讲分为两种:
- 程序内部的接口:方法与方法、模块与模块之间的交互,如登录发帖,发帖就必须要登录,如果不登录不能发帖,发帖和登录这两个模块之间就要有交互,就会抛出一个接口,进行内部系统调用。
- 系统对外的接口:从别人的网站或服务器上获取资源或信息,对方不会提供数据库,只能提供一个写好的方法来获取数据,如购物网站和第三方支付,购物网站支付时可选择第三方支付方法,但第三方不会提供自己的数据库给购物网站,只会提供一个接口,供购物网站进行调用。
这便意味着开发的人甚至团队都不一样,为了便于沟通,便有了接口文档。从这里可以看出,接口文档大多时候是给开发看的,那么产品为什么要会看这玩意呢?
首先,在迭代或依赖其他系统时,你能明确知道有哪些资源。例如下面这个关于微信菜单创建的接口,从这个接口的参数“type”的说明,我们就能清楚的知道,微信菜单能实现3种交互:一是直接点击打开网页;二是消息推送;三是跳转小程序。