PHP什么样是好的API设计?

PHP 1

什么样是好的API设计?

什么是API?

小编们假若是在进展编制程序大家就供给不停的布置API。

API一言以蔽之可以是贰个调用的函数,一个接口。

空洞来说,接口是3个内聚系统暴漏给外部的方方面面消息,包含但不限于:

调用格局:比如通过lib库可能http接口等。

调用约定:比如lib的函数签名可能HTTP的参数,http
method也许头音信,长短链接等等。

信赖关系:比如接口的调用需求涉及到第①方只怕其余的准备工作等等。

API就像一个人一律,大家和一个API打交道的时候必要驾驭这厮的风味偏好等,有的人很好相处,而部分人令人很高烧,尤其是您不得不和她打交道的时候,和人同样,尽管您不得不和他打交道,要改变她的个性是很痛心的,人的“本性难移”,
API也同等,一旦公布了,要改成的本金就非常的大一点都不小。

好的API应该享有:

简单学习:就算没有文档也便于使用。

不错误用:这点很重点,要削减使用者的心智负担。

不难满意需要:API的完备性和正交性。能够不难的知足要求,完备性保险功用完全,正交性保障接口的简洁性,不要求为有着的急需提供接口,而是由用户去组合。

容易扩大性

如何设计精良的API?

专一:一个API的机能应该是十足的,需求能够很简单的解释和明白,也就会更好用。

尽心尽力的小:小有许多的优势,易于驾驭和护卫。

尽量少的外表重视:收缩使用者的资本。

设计不被完结影响:不要暴漏完结细节给用户,竟或者少的展露,不止是个中细节,对于不须要的接口尽量不要发表,比如选用不多的效应,能够一时不暴光接口。

美艳的命名:尽量做到自描述。

圆满的文书档案

设想品质


Thanks ~ 

AD:

PHP 2

PHP工程师订阅号

PHP团队支付中相见的那贰个坑,看本人是什么样缓解的?

相关文章