apidoc 生成 RESTful API 的一个小工具 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
xnotepad
V2EX    分享创造

apidoc 生成 RESTful API 的一个小工具

  •  
  •   xnotepad
    caixw 2016 年 7 月 11 日 6172 次点击
    这是一个创建于 3539 天前的主题,其中的信息可能已经有所发展或是发生改变。

    一个提取注释生成文档的工。之前撸项目时的一个副产品,目前算是比较完善了。

    1. 跨平台, linux 、 windows 、 macOS 等都支持;
    2. 支持语言广泛,即使是不支持,也很方便扩展;
    3. 支持多个不同语言的多个项目生成一份文档;
    4. 输出模板可自定义;

    目前已经支持: C#、 C/C++、 Go 、 Java 、 Javascript 、 Perl 、 PHP 、 Python 、 Ruby 、 Rust 和 Swift 。

    文档:http://apidoc.tools

    仓库在:Github 或是 oschina

    16 条回复    2016-07-12 20:41:21 +08:00
    123123
        1
    123123  
       2016 年 7 月 11 日
    http://apidocjs.com/ 是什么关系?
    xnotepad
        2
    xnotepad  
    OP
       2016 年 7 月 11 日
    @123123 没关系,重名了。
    murmur
        3
    murmur  
       2016 年 7 月 11 日
    和 swagger 全家桶系列比呢?
    xnotepad
        4
    xnotepad  
    OP
       2016 年 7 月 11 日
    @murmur 没那么复杂,就提供了一个命令行工具,可以从源代码里提取特定的注释,然后生成 HTML 或是 json 文档。
    fwrq41251
        5
    fwrq41251  
       2016 年 7 月 11 日
    没有 demo 吗,生成的 html 长什么样?
    xnotepad
        6
    xnotepad  
    OP
       2016 年 7 月 11 日
    @fwrq41251 http://apidoc.tools/example/doc/index.html 默认模板长这样,非设计出身,弄得有点丑。想好看的话,可以自己设计模板,在配置文件中指定 template 参数就可以了。
    puras
        7
    puras  
       2016 年 7 月 11 日
    能像 Swagger 一样,直接测试么?
    xnotepad
        8
    xnotepad  
    OP
       2016 年 7 月 11 日
    @puras 不能,目前定位就是一个文档工具。
    lijinma
        9
    lijinma  
       2016 年 7 月 11 日
    @xnotepad 如果用还需要加个测试,用不了多少代码,你可以的。
    penjianfeng
        10
    penjianfeng  
       2016 年 7 月 11 日   1
    感觉很赞,已经收藏,感谢分享:-)
    xnotepad
        11
    xnotepad  
    OP
       2016 年 7 月 11 日
    @lijinma 之前有过这方面的相法,不过在这方面,肯定不如 postman 之类的工具方便好用,所以就暂时放弃了。**或许**在下个版本会加上去吧。
    xuqingkuang
        12
    xuqingkuang  
       2016 年 7 月 12 日   1
    已经 Star
    baoguok
        13
    baoguok  
       2016 年 7 月 12 日   1
    感谢,很好用.
    一直在用这个生成兼职项目的文档
    liteneo
        14
    liteneo  
       2016 年 7 月 12 日 via iPhone
    liteneo
        15
    liteneo  
       2016 年 7 月 12 日 via iPhone
    Test
    fhefh
        16
    fhefh  
       2016 年 7 月 12 日
    nice mark
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     1067 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 33ms UTC 18:48 PVG 02:48 LAX 11:48 JFK 14:48
    Do have faith in what you're doing.
    ubao msn 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