V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
Coser
V2EX  ›  程序员

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

  •  
  •   Coser · 2017-10-31 16:07:17 +08:00 · 2505 次点击
    这是一个创建于 2578 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

    1

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

    2

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

    3

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

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

    5

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

    6

    导出 word 文档

    7

    8

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

    3 条回复    2017-11-28 15:07:03 +08:00
    scarqin
        1
    scarqin  
       2017-11-01 17:21:32 +08:00
    支持!我最近也在用 eolinker!
    vocalman
        2
    vocalman  
       2017-11-06 17:16:53 +08:00
    可以导出 word 的功能简直是良心
    Charlesling
        3
    Charlesling  
       2017-11-28 15:07:03 +08:00
    不错 支持
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1646 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 16:52 · PVG 00:52 · LAX 08:52 · JFK 11:52
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.