开发人员在启动API之前应避免的5个错误
标签搜索
侧边栏壁纸
  • 累计撰写 91 篇文章
  • 累计收到 7 条评论

开发人员在启动API之前应避免的5个错误

admin
2020-05-25 / 0 评论 / 196 阅读 / 正在检测是否收录...

在API行业中,时间就是金钱,每个人都希望及时为API的里程碑事件:最终发布。延迟此事件的代价可能非常高昂,因此,API可以集成得越早越好。许多开发人员开始工作时就非常清楚时钟在滴答作响。但是,从长远来看,优先考虑快速启动(这会付出其他所有代价)会造成很多损害。匆忙启动可能会导致集成不稳定,错误和错误,最终用户满意度降低以及对API公司的信任度下降。

这就是开发人员面临的挑战。一方面,您不希望API版本过慢。另一方面,过于急于在产品真正准备好推出之前将其推向市场并不好。考虑到这两个极端,开发人员可以采取的最佳措施是什么?

这很大程度上与了解最常见的启动前错误有关。这里有五个应该避免的地方。预见这些错误可能是您为API所做的最大努力。

就API而言,并非100%清晰

 


大多数开发人员都想当然地认为,关于API的意图,每个人都在同一页面上。但这就是为什么它在此错误列表中排名第一。随着开发过程变得越来越复杂,忽略目标很容易。您最终可能会发现选择了错误的API来使用。或者,也许您没有在API设计工作流程中专注于正确的优先级。

为了避免这种情况,请特别注意确定要开发的API的类型。此外,请确保您所做的工作完全符合客户的期望。您不想最终解决错误的问题,因此请确保每个人都按计划解决正确的问题。

仅针对单个请求-响应交互测试API

 

 


新手在测试中的一个错误是仅查看单个调用和响应,而没有将API视为整个应用程序。这决定了API的完整性和可集成性,而不是特定调用的性能。仅根据某些调用和响应的成功来判断API,可能会导致对整体性能的错误安全感。您可以想象,这对于发射来说可能是致命的。

通过全面地进行测试并针对实际场景进行广泛检查来防止这种情况。使用真实数据,并根据预期的API用户访问量测试API的性能。这是为顺利推出市场做好准备的最佳方法。

修复软件开发套件(SDK)

 

 


开发人员经常犯的另一个错误是,在启动之前,将API与尽可能多的SDK打包在一起。这样做可能是因为相信许多SDK会为API的采用带来好处。

但是这样做会改善API,还是会产生相反的效果?对于开发人员而言,SDK可能比他们值得的麻烦更多。如果它们不是您的外部开发人员所喜欢的编程语言,则可能一开始就没有必要使用它们。另外,API版本上的许多SDK可能意味着将来会推出更多代码更改。因此,这是您在发布之前肯定需要考虑的一个因素。

未在API的服务合同上设置

 

 


服务合同旨在将API的设计传达给所有相关人员。不立即达成一致是错误的。如果您尚未签订服务合同,则可能会增加您和您的团队正在处理的依存关系。这样一来,对于所有相关人员,API的预发布将变得更加困难。

您最好在启动前尽早采取的最佳措施是采用OpenAPI Specification(OAS)之类的格式。使用OAS将建立每个人都可以遵循的服务合同,并统一处理API的组件。由于每个人都将相对于API更好地了解其工作功能,因此在发布之前,您将做得更干净,更高效。

不考虑发布后会发生什么

 

 


开发人员犯的最后一个错误-但绝对不是引力方面的至少一个-不考虑发布后会发生什么。考虑可能会引入系统的新复杂性,以及API可能遇到的新问题。即使在计划发布产品之前,您也应该对产品的未来有正确的答案。

向您的客户展示正在开发的API的模型或设计文档,以进行更多工作。然后,分享您将共同监督的潜在问题。这将使您的客户具有协作和信任感,这无疑将使API集成对每个人来说都是更加积极的体验。

总而言之,远见很重要。事先意识到问题会在API启动之前,期间和之后确保更好的命运。着眼于为市场发布准备最好的产品。

3

评论 (0)

取消