做 app 服务器端的朋友们,有啥好的 api 文档写作工具没 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
请不要在回答技术问题时复制粘贴 AI 生成的内容
yemoluo
V2EX    程序员

做 app 服务器端的朋友们,有啥好的 api 文档写作工具没

  •  
  •   yemoluo 2015-12-10 11:11:51 +08:00 5176 次点击
    这是一个创建于 3595 天前的主题,其中的信息可能已经有所发展或是发生改变。

    最近,用了 gitlab 的 wiki 写写写 总感觉欠缺点什么
    所以来看看大家都用什么工具

    21 条回复    2016-10-27 17:35:27 +08:00
    hging
        1
    hging  
       2015-12-10 11:15:12 +08:00
    swagger
    hao123yinlong
        2
    hao123yinlong  
       2015-12-10 11:25:53 +08:00
    apidoc.js
    globit
        3
    globit  
       2015-12-10 11:40:06 +08:00   2
    ixiaozhi
        4
    ixiaozhi  
       2015-12-10 11:46:31 +08:00
    我用的 mweb 写 Markdown 的 估计没有其他人了吧
    janxin
        5
    janxin  
       2015-12-10 11:54:59 +08:00
    apiary.io ,说实话并不太好使....swagger 就是嫌写起来太麻烦
    freeznet
        6
    freeznet  
       2015-12-10 11:55:07 +08:00
    @ixiaozhi 我也在用 mweb 和自带的 foundation-book 主题写文档
    csensix
        7
    csensix  
       2015-12-10 11:57:06 +08:00
    MkDocs
    felixzhu
        8
    felixzhu  
       2015-12-10 12:15:51 +08:00
    mkdocs
    gitbook
    jerray
        9
    jerray  
       2015-12-10 13:13:01 +08:00
    随便搞个支持 Markdown 的编辑器,然后用 API Blueprint https://apiblueprint.org/ 。写起来感觉十分流畅。
    keepcleargas
        10
    keepcleargas  
       2015-12-10 13:27:57 +08:00   2
    slate https://github.com/tripit/slate, 可读性强,导航方便.
    hongcha
        11
    hongcha  
       2015-12-10 13:36:23 +08:00
    gitbook 太完美了
    TangMonk
        12
    TangMonk  
       2015-12-10 13:44:52 +08:00
    @janxin rails-swagger 自动生成
    angryRabbit
        13
    angryRabbit  
       2015-12-10 17:54:28 +08:00
    swagger 用起来有些复杂,现在最流行的文档工具好像是 word 。。。
    yemoluo
        14
    yemoluo  
    OP
       2015-12-10 23:06:43 +08:00
    @keepcleargas 看起来好漂亮
    smilebaby
        15
    smilebaby  
       2015-12-11 09:40:21 +08:00
    MdCharm 桌面编辑器
    kkwezard
        16
    kkwezard  
       2015-12-11 09:44:46 +08:00
    python 后端,直接从 doc_string 用 sphinx 生成的。
    stdying
        17
    stdying  
       2015-12-11 17:58:02 +08:00
    我公司,文档残缺
    yemoluo
        18
    yemoluo  
    OP
       2015-12-11 18:20:26 +08:00
    all 谢谢各位,如果有更好的文档工具都分享分享,暂时先用 swagger
    imNull
        19
    imNull  
       2015-12-16 19:18:56 +08:00
    有人用这个么, easyapi ,但似乎功能不多
    hpu423
        20
    hpu423  
       2016-03-16 09:46:22 +08:00
    sinux
        21
    sinux  
       2016-10-27 17:35:27 +08:00
    @hongcha 慢得出奇,而且不能在线编辑,美什么......
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2906 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 29ms UTC 14:12 PVG 22:12 LAX 07:12 JFK 10:12
    Do have faith in what you're doing.
    ubao snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86