国内最专业的IT技术学习网

UI设计

当前位置:主页 > UI设计 >

解锁设计优质API的五种秘籍

发布时间:2019/09/17标签:   您的    点击量:

原标题:解锁设计优质API的五种秘籍
【51CTO.com快译】现在,跟着咱们构建软件方法的变更,以及API平台的爆炸式激增,各至公司都必需以更快的速率构建出本人的产物、并推向市场。现在,简直全部的软件需要都须要经过API来供给响应的处理计划,此中包含:付出类API、通讯类API、以及传输类API等数千种。那末咱们该怎样计划并构建出一个优良的API呢?不管您的目的是要构建一个开源的API、一种API平台(https://dzone.com/articles/what-is-an-api-platform)、仍是能关心其余开辟者与本人的产物相集成的API,您都必需尽力优化开辟者的API休会(DX)。解锁设计优质API的五种秘籍不管作为产物司理,仍是技巧开辟职员,您都须要在每个API的计划决议上,充足斟酌到终极用户,只要如许他们才会情愿应用您开辟出的API。在此方面,Facebook就是一个十分好的例子。在晚期,他们在交际媒体的游戏平台上就开发了一个强盛的开辟者社区,以便利各人构建出差别的游戏。固然Facebook也可能从中赢利。为了可能在一直变更与进展的SaaS情况中脱颖而出,您能够经过受权用户构建自界说的利用顺序(乃至是在您所不懂得的平台上供给完善的应用休会),来让他们发生所谓“驾御的快感”。个别而言,一般API应该存在以下基础特征: 存在必定的鲁棒性,以保障99.9%(或更高)的畸形运转时光 存在疾速呼应才能,或呼应耗时较短 可能无缝更新,或无需引入严重变革操纵 可能颁布各个构建的模块,而非一个动态固化的处理计划上面,咱们将和您深刻探讨计划优良API所应该留神的五个方面: 收缩可贵的时光 将您的文档置于网站的主页 在API中保障形象的分歧性 计划面向将来的API 妥当治理好潜伏的变革1.收缩可贵的时光一个优良的API应该可能收缩开辟职员的可贵时光(TtV)。也就是说,在开辟职员开端与您的API集成之前,就可能依据对应的用户手册,测试无关cURL(译者注:一种应用URL语法,任务在下令行里的文件传输东西)的呼应,以证实API本身的应用代价。您能够在Nylas文档(https://docs.nylas.com/reference)中,找到相似的示例。即便您可能供给测试令牌(test tokens),应用一通百通(first-time-every-time)的框架也十分主要的。经过应用测试令牌的相干典范,那些不熟习cURL下令操纵的开辟职员,也可能像其余人那样来测试令牌的过程,检讨API能否可能完整依照设定运转上来。此处恰好须要配有精良的文档阐明。合乎用户的冀望在构建API时 ,请切记一个成绩:该API能否完整合乎,用户冀望在第一次实验时所履行的操纵?在大少数情形下,您须要在API的有用性方面采用“初次把将准确的事做对(do the right thing right the first time)”的方式,以保证所供给的API确实可能收缩开辟者可贵的时光(TtV)。从开辟职员第一次交互开端,该API就可能疾速无效地处理那些存在挑衅性的技巧成绩。因而,请按期检讨并测试本人的API,确保用户可能顺遂地实现初次互动,并为后续应用建立信念。应用SDK来进步效力SDK是增加集成进程呈现“磨擦”的适合方式之一。它关于确保开辟职员可能尽快地找出API中的SDK集成参数,也长短常主要的。经过应用简略的Ruby、NodeJS或Python SDK,开辟职员能够在较短的时光内,懂得API是怎样在其抉择的框架内运转的,进而高效地实现功效完备的集成。记着:固然SDK须要破费必定的时光来创立和保护,但它们确实可能明显地改良开辟职员的休会、并下降他们的TtV。2.将您的文档视为网站的主页因为在您的首页上就能猎取API的相干文档,因而开辟职员能够将其参加扫瞄器的书签、或安排到明显的地位。固然,您的API文档岂但要直观且用户友爱,并且要可能遵守必定的逻辑流程。说到API文档的易猎取性和易用性,Stripe(https://stripe.com/)就是一个很好的例子。以下图所示,它的文档易于导航,左边边栏上有着清楚的名目,右边则是Stripe API胜利付款的简略6步流程:

版权信息Copyright © 银河官网 版权所有    ICP备案编号:鲁ICP备09013610号