构建API的方法

在当今超连接的世界中,API日益普及,遍及软件领域,允许进行新的和经过改进的创新来推动战略和业务计划。
近年来,一种构建和使用RESTful API的新技术在业界迅速获得了广泛的关注,如何制定API开发策略,以及大型项目进行版本控制成为优先处理的问题。

什么是RESTful API?

RESTful API由后台提供服务给前端调用。前端调用API向后台发起HTTP请求,后台响应请求将处理结果反馈给前端。也就是说RESTful 是典型的基于HTTP的协议。

构建API的方法

在“设计优先”方法中,重点是在编写代码之前首先设计各个API。该设计是一种人类和机器可读的参考文档,以RESTful API规范或其他描述语言编写,可以细化到代码级别。在“文档优先”方法中,开发流程从场景文档开始,因为高级的、以客户为中心的用例场景才是优秀API的关键所在。

“设计优先”的支持者倾向于谈论单个API的设计,甚至是单个API代码的设计。用户正在尝试使用大量API来完成实际的工作,而场景文档参考了如何最好地完成这些特定任务。将注释放入文档中,使它们能够为每个API生成API描述语言文档。API描述语言来自他们的文档,而不是相反。”

但是,这种方法不是集中式的,只有某些团队遵循此方法。设计至上或文档至上的方法对于API开发过程(通常不是敏捷过程)非常有用,因为在生产过程中发布给API的突破性更改的数量是有限的,并且会持续一段时间。也就是说,由于API描述语言还没有完全发展到设计层面,因此用于开发API的方法存在局限性。

归根结底,要适应不同的开发方法需要一定的技能水平,这实际上归结为团队的实力和成熟度。使用不同方法的灵活性也是Eolinker的核心原则,Eolinker:www.eolinker.com是一个面向事物的集成开发平台。Eolinker允许团队遵循最适合的工作流,深入API生命周期的各个方面,无论是设计、文档还是部署。

版本控制策略

严格的版本控制策略,有助于防止破坏性更改,同时允许各种单元添加无限量的非破坏性更改。事实证明,该策略非常强大,因此该团队无需更新整个版本。将来,肯定会对API进行重大更新,这将要求发布新版本的API。关于版本控制的建议是始终将用户牢记在心,当新版本问世时,V1将在很长一段时间内继续存在,以便客户逐渐放弃使用V2。

原文地址:https://www.cnblogs.com/dc20181010/p/14631942.html