如何使用eolinker一键快速生成API接口文档

现公司已经有不少接口托管在eoLinker上了,最近因为需要提供接口文档给甲方,之前使用eoLinker的初衷主要是其接口文档清晰简洁有条理,也可用于协作、在线分享。现在项目组经理顿时慌了,用时一时爽,一直依赖eoLinker来进行接口文档的管理,哪有写什么pdf格式的接口文档啊。
庆幸的是,发现eoLinker支持一键生成Api文档,出于兴趣,对其导出功能简单研究了一下。这里作为经验分享给大家~

导出接口文档,首先进入需要导出的项目的概况页面,找到“导出项目”选项,点击

如何使用eolinker一键快速生成API接口文档

选择需要导出的项目格式,这里可导出eoLinker格式、html格式、企业版支持导出pdf格式和word格式。

如何使用eolinker一键快速生成API接口文档

若想让项目再次导入到eolinker平台上,则需要导出eoLinker格式,eolinker格式实际为json字符串。(eoLinker格式是开源及线上版的通用导入导出格式)

如何使用eolinker一键快速生成API接口文档

导出格式为json,方便导入导出,不便阅览。

若导出为html格式,其实际导出为zip压缩包,包里包括html样式及相关数据,从index.html中进入。

如何使用eolinker一键快速生成API接口文档

eoLinker企业版支持还导出pdf格式和word格式,其导出的内容格式恰好和我们平时写文档的习惯相似,导出的文档就像是我们自己编写的一样。
导出pdf文档

如何使用eolinker一键快速生成API接口文档

导出word文档

如何使用eolinker一键快速生成API接口文档

如何使用eolinker一键快速生成API接口文档

好工具固然重要,但切实利用好工具的功能,才能提高工作的效率。

相关推荐