接口设计应该遵循以下原则：

  • 可获取

软件接口的存在是为了传输数据，那么这些需要传输的数据就必须是可获取的，无法获取的数据自然是无法传输的。设计接口就应当知道哪些数据是可获得的，这些数据是如何获得的，获取这些数据需要什么样的权限？

  • 可转换

软件接口对于不一定都是原封不动地传输数据，有时需要对数据进行必要的转换，将数据转换成信宿能够接受的格式。因此，设计接口就要定义好转换映射表和转换逻辑。

  • 可验证

如果软件接口将数据传输到信宿时是要写入数据，则接口设计应当具备数据验证的功能，这个验证应当在写入操作之前完成。

  • 可调试

软件接口传输的数据无论是用于读取还是写入，都要求其过程是可调试和可监控的，也就是说，设计接口应考虑提供可调试的接口。

  • 回馈机制

当软件接口将数据传输到信宿之后（特别是写入数据的场景），信宿需要提供反馈信息给信源。回馈信息包括成功或失败的状态和理由。

  • 回滚机制

如果数据传输到信宿是要写入数据，一旦数据写入失败，信宿应当具备将被修改的数据可以返回到修改之前的状态的能力。

  • 负载平衡

软件接口传输数据不能以牺牲软件系统的性能为代价。设计接口要评估数据传输对软件系统的影响，如运行时间、运行频率、通信能力、数据吞吐量等。设计人员应该明确提出负载平衡方面的要求，避免发生接口拖累软件系统性能的情况。

  • 可追溯

通过软件接口进行数据的传输应当是可追溯的，即每次数据传输都有历史记录，以方便追溯数据和了解当时的情况。

这正是：

接口设计八原则，设计接口应遵守
通用特定都包括，根据实情做选择