企业应该采取文档优先的方法来开发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

标签：Eolinker,开发人员,API,文档,开发,MockAPI,加速
来源： https://www.cnblogs.com/dc20181010/p/14232918.html