不会生成接口文档?利用 eolinker 一键快速生成 API 接口文档

2017-10-31 16:07:17 +08:00
 Coser

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

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

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

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

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

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

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

导出 word 文档

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

2505 次点击
所在节点    程序员
3 条回复
scarqin
2017-11-01 17:21:32 +08:00
支持!我最近也在用 eolinker!
vocalman
2017-11-06 17:16:53 +08:00
可以导出 word 的功能简直是良心
Charlesling
2017-11-28 15:07:03 +08:00
不错 支持

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/402307

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX