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

你们团队都是怎么管理 API 文档的

  •  
  •   jimyan ·
    sansanboy · 2017-02-16 08:34:41 +08:00 via iPad · 16820 次点击
    这是一个创建于 2837 天前的主题,其中的信息可能已经有所发展或是发生改变。

    api   文档是用 wiki 还是 doc

    第 1 条附言  ·  2017-02-16 11:08:06 +08:00
    除了 api 文档,还有需求设计文档。所以我的问题应该是怎么管理文档的,包括需求文档、设计文档、 api 文档等
    第 2 条附言  ·  2017-02-16 20:31:13 +08:00
    总结如下,后面再补充
    Swagger
    Confluence
    showdoc
    口头传述
    gitlab 传 md....
    天啦,还有 API 文档,没听说过
    raml
    wiki
    gogs
    apidoc
    quip
    意念传输
    postman
    RAP
    102 条回复    2019-10-30 18:58:30 +08:00
    1  2  
    zhangv
        101
    zhangv  
       2018-01-02 11:35:31 +08:00
    我们用 swagger
    根据实际需要来决定
    balabalaguguji
        102
    balabalaguguji  
       2019-10-30 18:58:30 +08:00
    易文档,这个很好用,这几年新出来的,强烈推荐下
    https://easydoc.top
    1  2  
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2200 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 00:56 · PVG 08:56 · LAX 16:56 · JFK 19:56
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.