什么是好的API设计?

什么是API?

我们只要是在进行编程我们就需要不停的设计API。

API简单来讲可以是一个调用的函数,一个接口。

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

调用方式:比如通过lib库或者http接口等。

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

依赖关系:比如接口的调用需要涉及到第三方或者其他的准备工作等等。

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

好的API应该具有:

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

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

易于满足需求:API的完备性和正交性。能够容易的满足需求,完备性保证功能完整,正交性保证接口的简洁性,不需要为所有的需求提供接口,而是由用户去组合。

易于扩展性

怎么样设计良好的API?

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

尽可能的小:小有很多的优势,易于理解和维护。

尽量少的外部依赖:减少使用者的成本。

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

良好的命名:尽量做到自描述。

完善的文档

考虑性能


如果你觉得眼前需要更好的提高你可以来千锋学PHP,国内最好的PHP机构。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • 什么是API? 我们只要是在进行编程我们就需要不停的设计API。 API简单来讲可以是一个调用的函数,一个接口。 ...
    新亮笔记阅读 6,233评论 7 27
  • 什么是API?我们只要是在进行编程我们就需要不停的设计API。API简单来讲可以是一个调用的函数,一个接口。抽象来...
    小小Q吖阅读 290评论 0 0
  • 如何定位好的API设计 转载2017-06-15 21:36:58 标签:php 什么是API? 我们只要是在进行...
    斯文小蚂蚁阅读 234评论 0 0
  • 什么是API? 我们只要是在进行编程我们就需要不停的设计API。 API简单来讲可以是一个调用的函数,一个接口。 ...
    编程那些事阅读 299评论 0 0
  • ThreadLocal提供了一个线程独立的变量。在不同线程中调set,get设置的值都是和该线程相关的。网上对Th...
    gatsby_dhn阅读 695评论 2 8