如何轻松搞定接口需求与文档.docVIP

如何轻松搞定接口需求与文档

一、前言

不懂技术的产品同学，天然的对技术相关的需求犯怵。比如说接口需求，接口是开发过程中避免不了的东西，作为产品经理，一定要知道。我一直负责集团的公共服务，所有服务都是通过「接口」与各个产品线对接。我也没有技术背景，当然在过程中遇到了一些问题，所以我总结了关于「接口需求」相关的内容。

说下：接口需求怎么提接口文档怎么看。

二、接口的作用

什么是接口？

看下边的例子：

微信获取用户基础信息接口：/cgi-bin/user/info/batchget?access_token=ACCESS_TOKEN

飞书查看全部工单接口：/open-apis/helpdesk/v1/tickets

这些url链接就是接口地址。通过调用接口地址，获取到想要的东西。对于接口的作用，我划分为3种：

1.前端与后端的数据处理

比如列表上有个「新增」的功能。前端开发出一个表单功能，当填完数据后，点击确定，前端会调用「新增数据接口」，将页面中录入的数据通过接口，传给后端，后端对传入的数据进行处理。接口处理完成后，会返回出具体的参数，前端根据返回的参数，给出对应的反馈信息。

比如当接口的校验没有通过时，则会通过接口返回出错误信息，前端会将错误信息在页面上进行提示。

同样的，对于删除数据、修改数据、查询数据等，都是通过接口的方式对数据进行处理。

2.跨系统的同步数据

两个系统之间进行数据同步。

比如我有个需求，需要使用到「系统用户信息」。对于「用户信息」，我司只有「账号系统」有，我需要和账号系统的产品经理沟通，对方提供给我一个接口文档，我们按照接口文档的要求进行数据同步。

同样的，当有需求要使用到你系统里的数据，也可以通过「接口」将数据同步给需求方。对于数据同步接口，数据同步的方式、数据同步的时机等等都是接口需求需要考虑到的内容。

这几点我们在下边详细说～

3.提供公共服务

通过接口对外提供服务能力，可以满足不同的系统或应用程序之间进行功能调用。比如说身份证归属地查询服务，通过输入身份证号查询出归属地。当需要使用这个功能的时候，都可以调用「身份证归属地查询接口」，来实现这个功能。

另外支付服务、登录服务、获取收货地址等等，能够对外提供的公共服务，我们都可以做成公共接口对外使用。

三、接口需求怎么提

很多同学认为接口是研发开发的，和产品没有关系，我之前也是这样想，后来发现这个并不对。接口是基于需求来开发的，里边涉及业务相关的内容，研发并不清楚具体的业务场景，如果产品经理不进行介入，就会导致接口的场景覆盖程度、扩展性受限。

不会提接口需求没关系，我们接下来细说：我们根据上边说的3种接口用途，看下需求如何提。

1.前后端数据处理接口

这类接口一般和功能相关，也不涉及到跨系统，可以直接通过功能需求描述，不用特意地对接口进行说明。在研发开始前，前端与后端根据需求进行功能拆分，后端开发接口，前端开发页面，然后前后端进行接口联调。

2.数据同步接口

无非2种：

你向别人提供数据：需要你定义接口需求

别人向你提供数据：需要你会看别人的接口文档

我们先看「你向别人提供数据」

举个例子：一条产品线有个需求，想使用你系统的「人员信息」数据，在他们系统的页面中展示出「人员信息列表」

我们先从以下角度思考：

1）数据能否提供？

是否该由自己系统提供，是否其他系统提供更好？

提供的数据能够满足对方需求，是否缺字段？

数据是否敏感数据？是否知识产权数据？

其它产品线是否也有这个需求，是否也需要这个接口？

对于这个接口是做成公共接口，每个业务方都能进行调用，还是只对这一个业务线提供。

一般情况下，数据同步接口都可以做成公共接口，让每个业务方都能使用此接口。

2）支持哪种同步方式？

①业务方直接使用接口实时搜索，直接列表展示

业务方通过接口实时查询数据，并展示出结果，不将数据放到自己的数据库里。好处是每次查询都是最新数据。但是这种方式很不建议，当有业务方需要用到你的数据的时候，也需要提醒对方不要使用这种方式。用他方的数据同步接口去进行实时查询，如果数据同步接口性能扛不住，接口挂了，那业务也会挂。

当需要对数据进行二次加工处理，这种方式就不支持了，只能让数据同步接口加需求。但是一般的数据同步接口都是公共接口，不仅有一个业务方使用，当这个接口不满足你的需求的时候，公共接口不会根据你的需求做个性化调整。

②业务方通过接口将数据存储到自己的数据库中，对数据进行二次处理

通过数据同步接口，将数据同步到自己的数据库中，单独存一份，与数据提供方做一层隔离。自己业务使用时，从自己的数据库中取数据。这样就算同步接口挂了，也不会影响自己的业务。同时，可以对获取的数据进行二次处理，灵活性更强。当业务方单独存储数据后，为了让两方数据保持一致，这就涉及到「数据更新」。