如何定位好的API设计?

什么是API?编程

咱们只要是在进行编程咱们就须要不停的设计API。函数

API简单来说能够是一个调用的函数,一个接口。性能

抽象来讲,接口是一个内聚系统暴漏给外部的一切信息,包含但不限于:学习

调用方式:好比经过lib库或者http接口等。设计

调用约定:好比lib的函数签名或者HTTP的参数,http method或者头信息,长短连接等等。接口

依赖关系:好比接口的调用须要涉及到第三方或者其余的准备工做等等。文档

API就像一我的同样,咱们和一个API打交道的时候须要了解这我的的特性偏好等,有的人很好相处,而有的人让人很头疼,尤为是你不得不和他打交道的时候,和人同样,若是你不得不和他打交道,要改变他的秉性是很痛苦的,人的“本性难移”, API也同样,一旦发布了,要改变的成本就很大很大。get

好的API应该具备:扩展

易于学习:即便没有文档也易于使用。命名

不易误用:这一点很重要,要减小使用者的心智负担。

易于知足需求:API的完备性和正交性。可以容易的知足需求,完备性保证功能完整,正交性保证接口的简洁性,不须要为全部的需求提供接口,而是由用户去组合。

易于扩展性

怎么样设计良好的API?

专注:一个API的功能应该是单一的,须要可以很容易的解释和理解,也就会更好用。

尽量的小:小有不少的优点,易于理解和维护。

尽可能少的外部依赖:减小使用者的成本。

设计不被实现影响:不要暴漏实现细节给用户,竟可能少的暴露,不止是内部细节,对于没必要要的接口尽可能不要发布,好比使用很少的功能,能够暂时不暴露接口。

良好的命名:尽可能作到自描述。

完善的文档

考虑性能

若是你以为眼前须要更好的提升你能够来千锋学PHP,国内最好的PHP机构。

相关文章
相关标签/搜索