接口需求,产品经理如何编写一份需求接口文档?

大雄 257 2022-07-11


本专辑为您列举一些接口需求方面的下载的内容,接口需求分析、接口需求文档谁写、接口对接需求文档等资源。把最新最全的接口需求推荐给您,让您轻松找到相关应用信息,并提供接口需求下载等功能。本站致力于为用户提供更好的下载体验,如未能找到接口需求相关内容,可进行网站注册,如有最新接口需求相关资源信息会推送给您。

什么是软件接口?

通常定义:所谓的A PI――应用程序编程接口,其表现的形式是源代码。API的发明和发展大大促进了计算机产业的进步,同时API几乎决定着日常运算的各个方面。

用于:接口就是两个独立系统之间同步数据或访问对方程序的途径。


如何理清楚接口的需求

  1. 调用接口的情况

一种是提供服务,一种是调用外部服务

我方是提供接口:是主动提供,还是对方系统来调用

我方是接口需求方:是对方主动提供,还是我方主动调用

2. 了解业务场景,是在哪一步业务流程

3. 数量访问量(如单条或分页)

4. 对实效性的要求:

  • 是否要求实时

  • 周期性的要求:多久访问一次

5. 根据需求选择合适的接口方式(这一步主要是与开发沟通,产品主要是了解各个系统之间数据的流转,清楚业务流程)

选择合适的接口方式

接口的类型

根据响应的机制进行区分
同步接口A系统请求B系统接口后,必须获得B系统的接口响应后才可以执行下一步操作例如:输入手机号码获取验证码,必须获取验证码校验成功后才可以执行登录操作
异步接口A系统请求B系统接口后,无需获得B系统的接口响应,可以直接执行下一步操作例如:淘宝发起一笔订单未支付时,可以再继续发起另一笔订单
根据接口的触发形式进行区分
分发接口A系统获得数据时分发给B系统(可以是多个接口)例如:一个管理后台黑名单列表产生新用户时,会通知各个系统
订阅接口A系统需要获取数据时调用B系统接口例如:股票交易系统账户查询余额时调用银行的余额查询接口,而股票系统并不需要存储该数据

实现方式

Mq消息队列是一个中间件,数据提供方将数据放到中间件,数据获取方从中间件中获取数据。注意增量同步还是全量同步
Otter同步数据同步方直接访问数据获取方的数据表将数据写入对应的表中实时性高,对数据的准确性要求高
http一般在功能设计中常用的接口是此种方式,双方通过http地址保持数据同步和通信

接口文档的编写

我方主动推送接口

对方主动请求接口

我方被动接受对方推送的数据

我方主动请求对方接口



版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:最美的在线接口文档knife4j,使用apipost工具快速生成在线接口文档
下一篇:警惕“零添加”背后的恐慌式营销!
相关文章

 发表评论

暂时没有评论,来抢沙发吧~