最新公告
  • 欢迎您光临欧资源网,本站秉承服务宗旨 履行“站长”责任,销售只是起点 服务永无止境!立即加入我们
  • 接口文档大多时候是给开发看的,记住明天给我一根冰糖葫芦

    又到周末了,快乐的黑色开始!阿翟兴奋的找朋友上号,朋友尔康却摆了摆手:“等一下,我开电脑开始开发。”

    一番激战之后,阿宅又来找朋友了:“你没事吧?” “不是,我被开发喷了,是我需求的bug,老板还骂我,你看。”

    为了让小伙伴们尽快上账,我们开始一起回顾:“这是关于基金购买流程的需求,我这里需要明确一下基金委托的类型。我问了我的” 爷爷找到我父亲,终于想通了。可以分为购买,赎回,固定投资。直到推出后,我才发现分类并没有完全定义。” “这东西不是在界面上写得很清楚吗?”

    “!!!什么是接口文档!我怎么从来没看过!”

    “你,你,你做理财产品半年了,连这点都不知道,那我就大慈大悲地教你,明天记得给我糖葫芦。”

    一、什么是接口文件?

    首先,什么是接口?你可以简单地把它想象成一个函数,你输入 x,它会告诉你 y。你不需要知道这个函数的逻辑,你只需要知道你输入了什么样的问题,你会得到什么样的答案。

    但是怎么丢x,又会出现什么样的y,需要通过接口文档了解。比如下表中,当你根据“输入参数”输入“委托方式”、“分支”等参数时,这个界面会告诉你什么是“资产账户”。

    恒生统一接入平台_外围接口规范(futures, options_20210812).xls

    二、产品为什么要能够看懂接口文档?

    一般来说小程序分享参数,有两种类型的接口:

    这意味着开发人员甚至团队都是不同的。为了方便交流,有接口文档。从中可以看出,大部分的接口文档都是用来开发的,那产品为什么要看这玩意儿呢?

    首先,您确切地知道在迭代或依赖其他系统时可以使用哪些资源。比如下面这个创建微信菜单的界面,从这个界面的参数“type”的描述中,我们可以清楚的知道微信菜单可以实现三种交互:一种是直接点击打开网页; 二是推送消息;三是跳转小程序。

    其次,当业务非常复杂时,可以通过接口进行逆向。比如我们在做期货需求的时候,我们并不知道期货产品是属于哪一类的。这时候小程序分享参数,我们可以找到恒生的接口,查看它的数据字典,我们发现答案其实很清楚:

    再次,在写需求文档或者和开发沟通的时候,发现不清楚的时候,也可以通过文档说清楚。例如,在对内容进行排序时,可能有多个时间:创建时间、更新时间、运行时间等。而且你想调用的时间可能和开发者理解的不一样,那你可以拉出接口文档告诉他我要的是CreateTime。

    当然,界面文档还有很多精彩的用途,比如强大的撕逼利器、装逼神器等等,欢迎大家在留言区写下你的文档故事~

    三、接口文档呢?

    小程序 分享到朋友圈_小程序分享参数_微信小程序分享接口

    接口文档有这么多好处,那我们该如何阅读呢?这里我们使用微信订阅通知的接口文档作为学习资料。

    如上图所示,接口通常分为请求方法、url、请求参数、返回参数四部分:

    1)请求方法:常用的方法有以下四种——GET、PUT、POST、DELETE。

    这个概念产品经理可以简单理解,一般不用测试

    2)url:以微信订阅通知界面的url为例

    我们可以将此 URL 分解为 5 个部分:

    同样,产品经理不需要很清楚。

    3)请求参数和返回参数:请求参数和返回参数分为五列:字段、描述、类型、默认值、是否需要。

    字段:类的属性

    说明:中文解释

    Type:属性的类型,只有四类:String、Number、Object、Array

    备注:一些解释,或者写简单的例子

    4)返回参数分两种情况讨论:

    只返回接口调用成功或失败:代码、原因

    返回参数:字段、描述、类型、默认值、是否必填

    四、一些值得学习的网址

    微信打开文档

    金融交易统一接入平台

    高德地图API

    站内大部分资源收集于网络,若侵犯了您的合法权益,请联系我们删除!
    欧资源网 » 接口文档大多时候是给开发看的,记住明天给我一根冰糖葫芦

    常见问题FAQ

    免费下载或者VIP会员专享资源能否直接商用?
    本站所有资源版权均属于原作者所有,这里所提供资源均只能用于参考学习用,请勿直接商用。若由于商用引起版权纠纷,一切责任均由使用者承担。更多说明请参考 VIP介绍。
    提示下载完但解压或打开不了?
    最常见的情况是下载不完整: 可对比下载完压缩包的与网盘上的容量,若小于网盘提示的容量则是这个原因。这是浏览器下载的bug,建议用百度网盘软件或迅雷下载。若排除这种情况,可在对应资源底部留言,或 联络我们.。
    找不到素材资源介绍文章里的示例图片?
    对于PPT,KEY,Mockups,APP,网页模版等类型的素材,文章内用于介绍的图片通常并不包含在对应可供下载素材包内。这些相关商业图片需另外购买,且本站不负责(也没有办法)找到出处。 同样地一些字体文件也是这种情况,但部分素材会在素材包内有一份字体下载链接清单。
    欧资源网
    一个高级程序员模板开发平台

    发表评论