apidoc 生成 RESTful API 的一个小工具 - V2EX
爱意满满的作品展示区。
xnotepad

apidoc 生成 RESTful API 的一个小工具

  •  
  •   xnotepad
    caixw Jul 11, 2016 6294 views
    This topic created in 3598 days ago, the information mentioned may be changed or developed.

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

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