当今这个软件时代,API的作用已经无需多言,API现在已经无处不在。全世界的企业都在当初寻找,甚至是收购好用的API。API的打造离不开这样一群人:开发者。
企业发布API,无非是出于两个主要的目的:
一点特别需要记住的是,开发者不仅仅是API的创造者,也是API的客户,API就是一个开发者做出来,给其他开发者使用的产品。
在针对其他开发者制作API的时候,有三个东西你一定要特别注意:
要想然其他开发者使用你的API,在制作这个API的时候,你就必须要尊重他们的时间和精力。要尊重其他开发者,首先要做好的就是API的文档。
在做API之前,先把文档写好。开发者都想要写的清楚、可读性高的说明文档,这样的文档才能帮他们用好API。除了详细的文档之外,你还应该为API配备一个快速说明文档,让使用者能够快速上手。这个快速说明文档之中应该包含一个基于某个使用场景的示范程序说明
不要觉得你自己知道其他开发者喜欢使用哪种语言。所以你还要做好Helper Libraries或是SDK。你的目标是要为API的使用者提供详尽的Helper Libraries。
在API设计的每一个阶段,你都要问问自己:“我能否在5-10分钟之内使用这个API做好一个有意义的程序?”不断的思考这个问题,能让你把API做的简洁、高效。
保持简洁性非常重要,不要陷入“越复杂、越强大”的思维陷阱。你不应该为了丰富的功能而牺牲API的简洁性。解决不同的问题,可以使用不同的工具,尽量让你的API保持简单,不要追求大而全。
就像乐高积木一样,使用相同的积木块,任何人都可以马上上手,然后逐渐打造出越来越复杂的造型。你的API也应该这样。
没有人能一天之内就做出完美的API。不断的从其他开发者那里获得反馈能帮你不断的完善自己的API。
在第一版API做好之后,马上把它放在其他开发者眼前,并且请他们将使用中遇到的问题以及想法反馈给你。
在你的API还在alpha阶段的时候,其他开发者给你提供的反馈会起到非常重要的作用,大部分重大的变更都应该在这个阶段完成。因为,在API达到beta阶段的时候,你应该要意识到,使用这个API所打造的应用,也处于beta阶段。如果你在这个时候做出重大的变更,那些使用了API的应用也会受到巨大的影响,这样会让API的使用者觉得你不够尊重他们的时间和精力。
原文来自:SDK.cn
声明:所有来源为“聚合数据”的内容信息,未经本网许可,不得转载!如对内容有异议或投诉,请与我们联系。邮箱:marketing@think-land.com
支持全球约2.4万个城市地区天气查询,如:天气实况、逐日天气预报、24小时历史天气等
支持识别各类商场、超市及药店的购物小票,包括店名、单号、总金额、消费时间、明细商品名称、单价、数量、金额等信息,可用于商品售卖信息统计、购物中心用户积分兑换及企业内部报销等场景
涉农贷款地址识别,支持对私和对公两种方式。输入地址的行政区划越完整,识别准确度越高。
根据给定的手机号、姓名、身份证、人像图片核验是否一致
通过企业关键词查询企业涉讼详情,如裁判文书、开庭公告、执行公告、失信公告、案件流程等等。