编辑导读：产品经理在工作中，避免不了要阅读接口文档，但是有很多新人产品对接口并不太了解。本文作者分享了接口文档从0到1的过程，从业务、产品层面阐述了接口文档的结构及内容的规范，希望对你有所帮助。
前两天接到领导的一个任务，让我根据业务流程图设计出一份接口交互文档出来；
此时小白的内心就有点慌，不知道要怎么开始……
经过一番冷静思考后，我翻出了之前参加过几个项目的接口文档及业务流程图；然后参考之前文档照葫芦画瓢，结合自己的经验理清了本次接口设计的思路及主体框架形成初步方案；再带着我的初步方案找领导确认；经过领导的一番耐心指导，确定了此次接口文档的框架及要点；就这样屁颠屁颠回去开搞了。
话不多说，直接进入主题
下图是经过抽象简化脱敏后的业务流程图，涵盖了融资的主要过程：
材料提交、材料审核、授信、借款申请、放款审核、放款、还款、逾期处理等。另外根据不同资金方，流程图中列举了一些不同点，希望对大家的工作有所启发。
步骤
在我看来接口设计主要分为2步：确定接口交互节点和规范接口内容
第一步是确定接口交互节点
确定交互节点主要分为两部分：
- 与业务流程强关的，时效性要求比较高的接口。如准入结果查询、资方额度查询等；
- 与业务主流程不那么相关的，时效性要求不高的。如贷中监控数据推送、还款跑批，逾期代偿等；
先将整个流程分为四大部分：材料提交、授信、借款、还款（含逾期代偿）；
然后结合业务路程图，按照在什么阶段、什么场景、触发关键节点的前置条件，交互的方向以及时效性，梳理出交互节点。如下图例子：
再梳理出时效性要求不高的那部分，格式与上面的保持一致。不过，这部分一般比较散乱，需要具备一定的经验才能考虑周全；我的做法是取所有项目接口的并集，然后根据项目情况删除一些用不到的。这样子第一步就完成了。
第二步是规范接口内容
同样也分为两部分：
- 确认请求和响应要传输的数据；
- 对传输数据类型进行定义；
这部分我仅从业务、产品层面思考。
- 每一个接口中都存在唯一的标识码（我猜应该是银行用于区分是哪项业务）；
- 根据所处的业务阶段，传输不同的字段。如授信接口，传姓名、身份证、手机号、银行卡等等；
接下来就是对请求、响应接口它的参数名称、出现要求、示例值、备注规定好，其他的如：字段长度、类型就交给研发了；
- 参数名称：一般是汉语转英语，如用户编号，UserID；
- 出现要求：主要有必须出现M、条件出现C、选择出现O三种；
- 示例值：如UserName：张三；
备注：对某些可能存在歧义或者有特殊规定的进一步说明；如ApprovalStatus，授信通过情况，01通过，02拒绝；
全部完成后，就是对这些接口汇总，生成目录，形成文档。最后就可以交差啦！
小结
简单来说，接口设计主要就是确定交互节点和规范接口内容；先根据业务流程梳理出交互节点，再深刻理解业务背景对接口进行详细定义；
本文由 @九牧 原创发布于人人都是产品经理。未经许可，禁止转载
题图来自Unsplash，基于CC0协议
给作者打赏，鼓励TA抓紧创作！
特别声明：以上内容(如有图片或视频亦包括在内)为自媒体平台“网易号”用户上传并发布，本平台仅提供信息存储服务。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.
