通过Eolinker中的对比改善API文档工作流程

使用Eolinker记录RESTful API,以人类和机器可读的格式清楚地详细说明API的所有资源和操作,为最终用户提供更简易的开发,更好的发现和更好的集成体验。

让合适的人员参与API文档

在API生命周期的设计和文档编制阶段,不仅仅只有开发人员和API设计师参与。如果团队认真考虑编写API文档,那么可能会有一名技术作家,他的职责是通过提供具体的文档来使用API的各种资源,从而提高API的可用性。 该人员可能没有积极参与API的初始开发,因此通常需要投入大量时间来理解如何为API编写准确的描述,并为最终用户提供适当的上下文。这个文档工作流程涉及到开发人员、技术编写人员和其他任何参与发布API的人员之间的大量协作。而且还需要有适当的可追溯性,以确保在更新定义时不会出现任何错误中断。

适用于文档工作流程的正确工具

在Eolinker,我们一直在努力提供工具,使团队中的所有成员在API的整个生命周期中能够更轻松地协同工作。借助评论和团队管理等功能,可以实现实时获取反馈,提出问题和解决问题。

Eolinker的对比

无论是要更新已使用的API定义,还是添加新的API,在更新API之前对比所做的更改很有帮助。以下是有关对比的功能:
在Eolinker中,打开API文档。切换到所需的版本。
单击编辑器右上角的“版本与变更历史”,然后 从菜单中选择版本进行“对比”:

在随后的页面中,可以看到对比的具体差异:

API对比功能不止对比单个API,还可以对整个项目中产生变化的API进行对比。具体操作如下:
进入“项目版本管理”界面,点击“版本对比”,选择需要对比的版本,可以查看到整个项目的两个版本不同点。

查看差异(即比较两个API规范),改善团队中更新和编辑API的工作流程。如果想要了解更多,请访问Eolinker官方网站:www.eolinker.com

posted on 2021-04-08 10:39  隔壁王书  阅读(126)  评论(0编辑  收藏  举报

导航