V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
fatedier
V2EX  ›  问与答

公司内部的 api 文档一般如何管理?

  •  
  •   fatedier · 2016-11-21 12:48:50 +08:00 · 3225 次点击
    这是一个创建于 2915 天前的主题,其中的信息可能已经有所发展或是发生改变。
    没有文档,需要看代码研究各种参数的功能和逻辑,耗时耗力,而让团队共同维护和及时更新文档也不是一件容易的事,想了解下各个公司都是怎么管理的。

    1. 有哪些工具比较合适,比如 wiki ?
    2. 根据代码注释自动生成是否更加高效和便捷?
    5 条回复    2018-09-15 05:38:48 +08:00
    ChenSir
        1
    ChenSir  
       2016-11-21 13:12:45 +08:00
    我们公司用的 wiki ,感觉这种方式还不错。但是,也要求文档别写得太水。
    tabris17
        2
    tabris17  
       2016-11-21 13:14:30 +08:00
    Confluence
    cnnbboy
        3
    cnnbboy  
       2016-11-21 14:29:50 +08:00
    Ouyangan
        4
    Ouyangan  
       2016-11-21 20:24:18 +08:00
    自己项目在用这个 , 非常友好方便 , http://swagger.io/
    公司....老接口口头相传 , 新接口 md 文档
    briclin
        5
    briclin  
       2018-09-15 05:38:48 +08:00 via Android
    swagger 貌似挺好
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1037 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 20:18 · PVG 04:18 · LAX 12:18 · JFK 15:18
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.