求推荐接口文档管理开源项目 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
请不要在回答技术问题时复制粘贴 AI 生成的内容
monkeyWie
0.65D
V2EX    程序员

求推荐接口文档管理开源项目

  •  
  •   monkeyWie
    monkeyWie 2020-08-13 11:58:11 +08:00 6747 次点击
    这是一个创建于 1886 天前的主题,其中的信息可能已经有所发展或是发生改变。

    目前了解的有 RAP2 、Yapi,这两个产品都在本地都跑了下,发现 YApi 比较符合需求,想问问大家还有其他的推荐吗?

    最好是支持以下特性:

    1. 项目组以及权限管理
    2. 支持导入 swagger.json
    3. 支持在线调试接口
    31 条回复    2021-09-10 13:30:29 +08:00
    gba
        1
    gba  
       2020-08-13 12:23:24 +08:00 via Android
    网易 NEI
    x537196
        2
    x537196  
       2020-08-13 12:29:23 +08:00
    魔改 showdoc
    mylxsw
        3
    mylxsw  
       2020-08-13 12:34:01 +08:00 via iPhone
    wizard,同时支持 markdown 和 swagger 。

    https://github.com/mylxsw/wizard
    AngryPanda
        4
    AngryPanda  
       2020-08-13 13:02:48 +08:00 via Android
    yapi
    monkeyWie
        5
    monkeyWie  
    OP
       2020-08-13 13:31:31 +08:00
    @gba 这个不支持私有部署吗
    vvmint233
        6
    vvmint233  
       2020-08-13 13:54:36 +08:00
    redoc
    gba
        7
    gba  
       2020-08-13 14:25:45 +08:00
    https://github.com/x-orpheus/nei 我看官网提供的项目地址,里面有部署方式。不过我没试过,一直用在线的。。
    johnsona
        8
    johnsona  
       2020-08-13 14:28:23 +08:00
    yapi 再加一票,swagger 阳光下的泡沫
    monkeyWie
        9
    monkeyWie  
    OP
       2020-08-13 15:03:16 +08:00
    @gba 好吧,不支持 swagger 导入,还是放弃了
    wangyzj
        10
    wangyzj  
       2020-08-13 15:05:48 +08:00
    yapi
    monkeyWie
        11
    monkeyWie  
    OP
       2020-08-13 15:11:06 +08:00
    @mylxsw 哇作者本人啊,我测试了下 wizard,设计非常棒,但是有一个缺点就是集成的原生的 swagger UI 太难用了,因为不支持按 tag 导航,建议导入 swagger 的时候自动把 tag 作为子菜单导入,然后 UI 的话可以考虑移植 knife4J,比原生的好用多了,谢谢~
    monkeyWie
        12
    monkeyWie  
    OP
       2020-08-13 15:11:55 +08:00
    @AngryPanda
    @jsisjs20130824
    @wangyzj
    我也觉得是 yapi yes 了
    byzf
        13
    byzf  
       2020-08-13 18:15:05 +08:00
    wiki.js 有人用过不, 貌似功能上差点意思.
    star7th
        14
    star7th  
       2020-08-13 21:47:17 +08:00
    一个非常适合 IT 团队的在线 API 文档、技术文档工具 github.com/star7th/showdoc
    star7th
        15
    star7th  
       2020-08-13 21:48:12 +08:00
    另外接口调试的话,配合这个工具使用 www.showdoc.com.cn/runapi?page_id=30291
    xsen
        16
    xsen  
       2020-08-13 21:54:00 +08:00
    yapi +1
    hangszhang
        17
    hangszhang  
       2020-08-13 22:58:53 +08:00
    去哪儿网 yapi
    fengpan567
        18
    fengpan567  
       2020-08-13 23:26:59 +08:00
    yapi
    bluehtt
        19
    bluehtt  
       2020-08-14 00:10:48 +08:00 via iPhone
    yapi
    uxstone
        20
    uxstone  
       2020-08-14 09:00:10 +08:00
    yapi
    edk24
        21
    edk24  
       2020-08-14 09:10:04 +08:00
    我们本地鸡用的 yapi
    balabalaguguji
        22
    balabalaguguji  
       2020-08-14 09:32:33 +08:00
    monkeyWie
        23
    monkeyWie  
    OP
       2020-08-14 09:35:15 +08:00
    @balabalaguguji 注意是私有部署哦
    balabalaguguji
        24
    balabalaguguji  
       2020-08-14 09:37:50 +08:00
    @monkeyWie 支持私有部署,不过没开源,免费的已经很够用
    monkeyWie
        25
    monkeyWie  
    OP
       2020-08-14 09:40:37 +08:00
    @balabalaguguji 好吧,还有一个很重要的好像不支持导入 swagger
    balabalaguguji
        26
    balabalaguguji  
       2020-08-14 09:43:36 +08:00
    @monkeyWie 支持 swagger,postman 。而且接口测试也是支持还能一键生成文档、Mock 。
    hpu423
        27
    hpu423  
       2020-08-14 10:14:15 +08:00
    apifox
    okampfer
        28
    okampfer  
       2020-08-14 11:33:01 +08:00 via Android
    各位同仁,yapi 是不是有一阵子没更新了?
    MarioLuo
        29
    MarioLuo  
       2021-09-10 11:50:40 +08:00
    [烟花][烟花][烟花]
    给大家推荐个 API 文档自动生成工具,可抛弃 swagger 了,已支持上传到 YApi, Rap2, Eolinker 平台。

    亮点:
    - [火] 零入侵、零成本: 自动解析 Javadoc 和 spring 等常见注解
    - [火] 开箱即用、智能 mock 规则: 默认就能生成很好的 mock 数据
    - [火] 多平台支持:目前支持 YApi, Rap2, Eolinker, Copy as cRUL

    Github: https://github.com/jetplugins/yapix
    IDEA 插件名称: Yapi X
    QQ 交流群:860701800
    monkeyWie
        30
    monkeyWie  
    OP
       2021-09-10 12:39:06 +08:00
    @MarioLuo 一定要通过 IDEA 插件生成吗,我们现在做的是提交代码的时候文档自动化生成,这个能实现吗
    MarioLuo
        31
    MarioLuo  
       2021-09-10 13:30:29 +08:00
    不支持集成到自动化,不过手动上传也就秒秒钟的事,如果你要自动化可以考虑 smart-doc 这个工具, 但是好像不支持 YApi, Rap2 之类
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2849 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 28ms UTC 13:51 PVG 21:51 LAX 06:51 JFK 09:51
    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