使用Eolinker拓展API设计

尽管越来越多的团队将设计视为软件开发生命周期及其API生命周期中的关键步骤,但很少人知道如何有效地大规模设计API。

在一个小组中使用有限数量的服务时,设计易于管理,依靠PDF样式指南或Wiki页面可能足以使信息保持一致。但是,当设计过程需要跨多个团队以及数百甚至数千个不同的API进行扩展时,会发生什么?

创建一个实际可扩展的设计过程

API生命周期管理工具(如Eolinker)改变了团队合作设计和记录API的方式。拥有诸如Eolinker之类的出色工具,可以在设计新服务时促进协作,并使这些服务的文档编制和集成测试变得更加容易,这对团队而言是一个巨大的帮助。

随着进一步推进项目,我们会意识到需要加快进程,提高效率。希望能够自动生成用户界面,并促进内部和外部团队之间的协作,而不会出现麻烦或通信问题。通过更快地设计和开发RESTful API,可以更快地将新服务和服务更新推向市场。

扩展设计流程的重要步骤:

1.调整团队
良好的API设计依赖API开发生命周期中所有涉众之间的有效协调。如果团队不符合设计要求,或者团队中的人员无法查看必要的设计,那么在尝试扩展一小部分API时,将遇到麻烦。

在设计过程中调整团队成员的一种常见方法是通过GitHub之类的协作工具。但是,尽管这些工具在软件开发生命周期中起着至关重要的作用,但针对管理API设计工作流程,它们可能会很复杂。

Eolinker旨在帮助团队在API的整个生命周期中保持一致。在Eolinker中,可以创建团队并邀请团队成员对API的设计和文档进行协作。并且可以根据团队成员在设计过程中的参与程度,分配角色并管理访问权限。

2.改善设计过程中的可见性
与团队在尝试扩展API设计流程时可能遇到的一致性问题类似,还有一项艰巨的任务,即提高团队的可见性。工具提供了可视化API所需的功能,它们是为了满足不同类型的API团队的协作需求而构建的。如果您使用API管理工具来处理API设计,则需要为整个团队提供一个平台来访问正在进行的设计不同服务的工作。

3.减少依赖
API开发不仅是一个复杂的过程,对于参与团队来说也是一个缓慢的过程。团跨团队的依赖性可能是阻碍团队从设计开始生成代码、编写文档和编写测试用例的最大因素之一。减少依赖关系的团队能够加快开发速度的方法之一是通过API MOCK或虚拟化。

Eolinker中集成了MOCKAPI,可以在Eolinker中创建新的API时自动创建模拟,也可以手动创建。MOCKAPI可以帮助在设计API时(即在开发人员实现API之前)测试API。这种集成使客户端应用程序开发人员甚至可以在后端准备就绪之前就开始自己的工作。无需编写任何代码,就可以允许API使用者针对MOCK开发客户端,MOCK保证以兼容的、真实的、有效负载进行响应。

4.提高设计的可重用性
在跨数百个API定义多个URL,特别是当URL共享公共语法并且具有相似的定义、路径、参数和响应时,设计过程可能非常繁琐,需要分别重复定义每个参数会减慢设计过程,并导致API设计不一致。

这就是Eolinker将引入API模板的原因。API模板是可重用的组件,可以在多个API和其他项目之间共享。API模板可以包含以下组件:定义、路径、参数、响应。用户可以创建API模板然后定义可以存储在模板中的可重用组件。

5.与工具集成
能够快速从设计过渡到记录、构建和部署API,对于建立可扩展的API设计流程至关重要。如果在API生命周期的初始阶段时出现问题,即使是最好的设计标准也无法扩展API设计。

Eolinker为团队构建一流的API设计平台,覆盖了API生命周期的所有环节,包括:API网关,源代码控制平台(如GitHub和GitLab),以及用于功能测试的测试工具等。
想要了解更多请访问:www.eolinker.com

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