跳到正文

业务接口分析

一个业务接口可以由一个或多个系统接口来实现。业务接口在分析时,只明确用途、业务价值、交互过程以及约束,不涉及解决方案。

首先要明确接口的用途与业务价值。在这个阶段,需要理清的最重要问题有三个:

  1. 接口由哪些子系统实现更为合理?推荐采用知情合一原则来判断,即由知道接口所需信息的子系统来实现接口。

  2. 哪些业务子系统会使用这些接口,实现什么业务价值?一个业务接口可能会有多个业务子系统使用,要逐一标识,并说明为什么会使用,即达成的业务目的是什么。

  3. 使用接口的频率如何?最好给出典型的频率值,可以是精确值,也可以是范围值,并且最好有一些相关的场景信息。

然后是细化接口的交互过程。可能会用到两个工具:

  1. 时序图:用于呈现接口的交互过程。

  2. 数据词典:用于细化定义每次交互过程中数据包的构成情况。

最后,确定接口的设计约束。首先要看客户的技术管理部门是否有要求使用特定的数据通信协议,或者是否有遗留系统。

对于数据传输、数据查询、加解密方面的性能要求,要进行一些分析。还要考虑系统的部署环境、使用者特点等方面,是否会带来一些设计约束。

最终要输出一个业务接口分析文档,主要有三个字段:

  1. 接口概述:包括接口名称、接口提供子系统,以及接口使用子系统信息,包括使用接口的子系统、业务目的、时机和频率。

  2. 接口交互过程与数据包说明:如果交互过程比较复杂,可以考虑使用时序图来呈现;数据包可以使用数据词典来细化。

  3. 接口设计约束:最典型的有协议要求、性能要求、环境要求以及其他要求。

有时候产品经理需要修改原有的业务接口。最好先说明原有的业务接口,再说明修改要求以及修改理由。