接口设计逻辑方法
2021-08-06 by uino 58 指南 流程

接口设计逻辑方法

说明

两层意思,一层是介绍一种接口设计时的思路,反过来,从接口设计出发可以反推接口调研时需要什么样的信息。

流程

image.png

  • 先调研对接数据类别:性能、告警、配置、log等。依据不同的数据类型类别选择接口协议。
  • 依据对接数据类别分别对应其数据源:数据库(ES/MYSQL等)、网络厂商(天旦、或客户自己接口等)。
  • 然后根据不同的数据源判断使用什么技术方法,网络协议(http、syslog、JDBC、中间件)等。然后调研字段映射(源字段:目标字段)、对接方式(数据库对接、网络接口对接;我方接收数据还是对方接收数据、我方发启请求还是对方主动推送;全量对接还是增量对接)、样例数据(接口规范:我方发起请求格式,返回值?如果是数据库,查询条件相对固定)。
  • 处理逻辑(告警信息是否压缩?例如对方推送过来是3条相同告警压缩成一条)。
  • DIX写接口读取数据和存储数据到数据库。
  • 产品可视化界面显示(左侧、右侧等)。