企业应该采取文档优先的办法来开发API。尽管测试驱动的开发强调编写设计良好的代码,但文档驱动的开发思考了API的可用性。

由文档驱动的API开发使开发团队在理论编写一行代码之前就能够思考从验收规范到UI和用户体验的所有内容,然而,它可能会减慢初始开发周期。在这些文档驱动的开发人员构建API之前,依赖于应用新设计的API的团队可能会碰壁。

MockAPI简介

因为生产力在企业中至关重要,因而工程团队须要打消软件开发的阻碍。在短少API的状况下,团队应尽早应用MockAPI来验证文档以及后续的实现和集成。顾名思义,MockAPI实质上是一个虚构的API,它承受示例申请并返回无效响应,因而开发人员能够应用非生产的API。

只管有些团队在外部构建和建设Mock服务器,用于缩小代码并进步生产率,但某些选定的第三方工具(例如Eolinker)能够轻松,高效地创立MockAPI。在API模仿过程中,文档必须与Mock服务器放弃同步。

Eolinker是规范的API管理工具。基于RESTfulAPI的文档标准使开发人员可能以简洁而富裕表现力的形式来文档化API,并主动生成MockAPI。

创立一个MockAPI

为了更好地阐明文档规范(如Eolinker)对于文档验证的价值,让咱们应用一些根本的API文档和API工具创立MockAPI。

首先,创立一些文档。对于任何文档驱动的开发我的项目,需包含如url,参数,响应和验证之类的信息。例如,以下是简略的用户登陆API文档的标准:

生成API文档后在MockAPI填写冀望信息。

调用MockAPI的url,设置冀望参数即可测试并用于开发。

结语

应用MockAPI进行文档驱动开发的简略示例显示了此办法的重要作用。借助功能丰富的API文档工具,开发人员能够设计正当、逻辑清晰的API,而不会毁坏典型的产品开发生命周期。
翻译:Eolinker
演示工具:www.eolinker.com