产品经理系列（9）：如何编写接口文档

​

        相信产品经理对「接口文档」并不陌生，「接口文档」常常出现在开发同学的口中，场景往往是这样的：

产品：本次的需求内容已经宣讲完毕，看下各位开发、测试、设计同学还有什么疑问没？

开发：需求已基本了解，下来还需要详细再看看，然后输出技术方案和详细的接口文档。

对，就是这样。那么很多人会有疑问，既然「接口文档」是开发同学写的，产品经理为何要写呢？

最开始我也有这样的疑问，后来做B端业务，接触更多第三方，发现「接口文档」其实也是需要产品经理写的，不过产品经理写的接口文档更偏业务，是为业务双方了解业务大概需要的字段，评估接口设计及需要的时间，由于此时双方业务细节还未最终确定，只是前期的业务沟通，如果此时介入研发资源，一来是对研发资源的浪费，二来，研发是需要了解具体的需求之后才能设计接口，而此时业务洽谈阶段，还远未到接口设计阶段。

在我平常的工作中，做开放平台和B端业务的产品经理会经常与「接口文档」打交道，那么产品经理如何来设计业务的接口文档呢？下面提供一种比较简单的操作步骤：

1、明确接口的业务背景

接口的业务背景其实就是需求的业务背景，比如该需求是将库存流水数据同步给业务方，那么该接口就是用于同步库存流水的接口。

2、梳理接口的需求点

如上面示例，同步库存流水，库存流水包含很多内容，比如sku、库存量、商户、门店、变动类型、变动来源、变动时间等等，将对于该需求你能想到的点全部罗列出来。

3、整理接口字段

特别说明：这只是产品从业务侧整理的接口文档，是为方便双方业务沟通及工时评估，到需求真正研发阶段，接口文档是需要开发同学详细设计的，比如接口类型、请求参数、返回参数、代码示例等等。