API通用设计原则

来源:互联网 发布:淘宝客微商城 编辑:程序博客网 时间:2024/05/22 01:33

什么是好的API

·        完备Be Complete

对确定重点支持的用户场景具有完备的功能支持。就是说,用户通过对一组API的调用能够完成预期的功能。

·        不冗余Be Minimal

在完备的前提下,API只提供最小的功能集合。不缺少、不冗余。

·        简单清晰Be Simple & Clear

接口设计简单清晰。每个接口都有自己明确的语义,并只专注于尽量单一的功能。产品概念简单、关系清楚。

·        易于学习Be Easy to Learn & Use

符合用户的直觉;接口设计有统一的范式,用户可以举一反三。极致是没有文档用户也知道怎样调用接口。

·        可扩展Be Extensible

设计具有扩展性,能够在一定程序上适应变化,API在发展中具有后向兼容性backward-compatibility)。

1 0
原创粉丝点击