API 设计流程中的注意事项

机构:北大青鸟 时间:2015-12-19 点击:678

   征集需求

  在开始之前,你可能会收到一些解决方案,它们不一定会比现有的方案好,而你的任务是以用例的形式提取真实需求,并制定真正合适的解决方案,这样构建出来的东西就会更加有价值。

  从简短的说明开始

  这时,编写简短的说明最为合适,编写时需要考虑的因素有:

  灵活性要远胜于完整性;

  跳出规则:听取意见并严阵以待;

  精炼短小才易修改;

  获得信任之后将其具体化,在此之中,编程很重要。

  尽早编写 API

  对每一个实现进行保存,以防丢失;

  在开始之前,列出一些合理的规定,保存所写说明,以防丢失;

  继续编写和充实 API。

  编写 SPI 尤为重要

  Service Provider Interface 即服务提供商接口,插件服务支持多种实现,例如 Java Cryptography Extension (JCE);

  发布之前编写多个插件;

  “三次原则”(“The Rule of Threes”):指的是当某个功能第三次出现时,才进行”抽象化”。

  维护切实可行的期望

  大多数 API 设计都过于约束;

  对可能会犯的错误进行预计,要用发展的思维来编写 API。

  更多资讯:武汉软件工程师培训学校

返回顶部