V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
fatedier
V2EX  ›  问与答

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

  •  
  •   fatedier · Nov 21, 2016 · 3972 views
    This topic created in 3448 days ago, the information mentioned may be changed or developed.
    没有文档,需要看代码研究各种参数的功能和逻辑,耗时耗力,而让团队共同维护和及时更新文档也不是一件容易的事,想了解下各个公司都是怎么管理的。

    1. 有哪些工具比较合适,比如 wiki ?
    2. 根据代码注释自动生成是否更加高效和便捷?
    5 replies    2018-09-15 05:38:48 +08:00
    ChenSir
        1
    ChenSir  
       Nov 21, 2016
    我们公司用的 wiki ,感觉这种方式还不错。但是,也要求文档别写得太水。
    tabris17
        2
    tabris17  
       Nov 21, 2016
    Confluence
    cnnbboy
        3
    cnnbboy  
       Nov 21, 2016
    Ouyangan
        4
    Ouyangan  
       Nov 21, 2016
    自己项目在用这个 , 非常友好方便 , http://swagger.io/
    公司....老接口口头相传 , 新接口 md 文档
    briclin
        5
    briclin  
       Sep 15, 2018 via Android
    swagger 貌似挺好
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   813 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 45ms · UTC 20:32 · PVG 04:32 · LAX 13:32 · JFK 16:32
    ♥ Do have faith in what you're doing.