编辑导读：产物司理在事情中，制止不了要阅读接口文档，可是有许多新人产物对接口并不太相识。本文作者分享了接口文档从0到1的进程，从业务、产物层面叙述了接口文档的布局及内容的类型，但愿对你有所辅佐。

前两天接到率领的一个任务，让我按照业务流程图设计出一份接 *** 互文档出来；

此时小白的心田就有点慌，不知道要怎么开始……

颠末一番沉着思考后，我翻出了之前介入过几个项目标接口文档及业务流程图；然后参考之前文档照葫芦画瓢，团结本身的履历理清了本次接口设计的思路及主体框架形成劈头方案；再带着我的劈头方案找率领确认；颠末率领的一番耐性指导，确定了此次接口文档的框架及要点；就这样屁颠屁颠归去开搞了。

话不多说，直接进入主题

下图是颠末抽象简化脱敏后的业务流程图，涵盖了融资的主要进程：

质料提交、质料审核、授信、借钱申请、放款审核、放款、还款、过时处理惩罚等。别的按照差异资金方，流程图中罗列了一些差异点，但愿对各人的事情有所开导。

步调

在我看来接口设计主要分为2步：确定接 *** 互节点和类型接口内容

之一步是确定接 *** 互节点

确定交互节点主要分为两部门：

与业务流程强关的，时效性要求较量高的接口。如准入功效查询、资方额度查询等；

与业务主流程不那么相关的，时效性要求不高的。如贷中监控数据推送、还款跑批，过时代偿等；

先将整个流程分为四大部门：质料提交、授信、借钱、还款（含过时代偿）；

然后团结业务旅程图，凭据在什么阶段、什么场景、触发要害节点的前置条件，交互的偏向以实时效性，梳理出交互节点。如下图例子：

再梳理出时效性要求不高的那部门，名目与上面的保持一致。不外，这部门一般较量狼藉，需要具备必然的履历才气思量周全；我的做法是取所有项目接口的并集，然后按照项目环境删除一些用不到的。这样子之一步就完成了。

第二步是类型接口内容

同样也分为两部门：

确认请求和响应要传输的数据；

对传输数据范例举办界说；

这部门我仅从业务、产物层面思考。

每一个接口中都存在独一的标识码（我猜应该是银行用于区分是哪项业务）；

按照所处的业务阶段，传输差异的字段。如授信接口，传姓名、身份证、手机号、银行卡等等；

接下来就是对请求、响应接口它的参数名称、呈现要求、示例值、备注划定好，其他的如：字段长度、范例就交给研发了；

参数名称：一般是汉语转英语，如用户编号，UserID；

呈现要求：主要有必需呈现M、条件呈现C、选择呈现O三种；

示例值：如UserName：张三；

备注：对某些大概存在歧义可能有非凡划定的进一步说明；如ApprovalStatus，授信通过环境，01通过，02拒绝；

全部完成后，就是对这些接口汇总，生成目次，形成文档。最后就可以交差啦！

小结

简朴来说，接口设计主要就是确定交互节点和类型接口内容；先按照业务流程梳理出交互节点，再深刻领略业务配景对接口举办具体界说；