V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
monkeyWie
0.65D
V2EX  ›  程序员

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

  •  
  •   monkeyWie ·
    monkeyWie · Aug 13, 2020 · 7094 views
    This topic created in 2086 days ago, the information mentioned may be changed or developed.

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

    最好是支持以下特性:

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

    https://github.com/mylxsw/wizard
    AngryPanda
        4
    AngryPanda  
       Aug 13, 2020 via Android
    yapi
    monkeyWie
        5
    monkeyWie  
    OP
       Aug 13, 2020
    @gba 这个不支持私有部署吗
    vvmint233
        6
    vvmint233  
       Aug 13, 2020
    redoc
    gba
        7
    gba  
       Aug 13, 2020
    https://github.com/x-orpheus/nei 我看官网提供的项目地址,里面有部署方式。不过我没试过,一直用在线的。。
    johnsona
        8
    johnsona  
       Aug 13, 2020
    yapi 再加一票,swagger 阳光下的泡沫
    monkeyWie
        9
    monkeyWie  
    OP
       Aug 13, 2020
    @gba 好吧,不支持 swagger 导入,还是放弃了
    wangyzj
        10
    wangyzj  
       Aug 13, 2020
    yapi
    monkeyWie
        11
    monkeyWie  
    OP
       Aug 13, 2020
    @mylxsw 哇作者本人啊,我测试了下 wizard,设计非常棒,但是有一个缺点就是集成的原生的 swagger UI 太难用了,因为不支持按 tag 导航,建议导入 swagger 的时候自动把 tag 作为子菜单导入,然后 UI 的话可以考虑移植 knife4J,比原生的好用多了,谢谢~
    monkeyWie
        12
    monkeyWie  
    OP
       Aug 13, 2020
    @AngryPanda
    @jsisjs20130824
    @wangyzj
    我也觉得是 yapi yes 了🤣
    byzf
        13
    byzf  
       Aug 13, 2020
    wiki.js 有人用过不, 貌似功能上差点意思.
    star7th
        14
    star7th  
       Aug 13, 2020
    一个非常适合 IT 团队的在线 API 文档、技术文档工具 github.com/star7th/showdoc
    star7th
        15
    star7th  
       Aug 13, 2020
    另外接口调试的话,配合这个工具使用 www.showdoc.com.cn/runapi?page_id=30291
    xsen
        16
    xsen  
       Aug 13, 2020
    yapi +1
    hangszhang
        17
    hangszhang  
       Aug 13, 2020
    去哪儿网 yapi
    fengpan567
        18
    fengpan567  
       Aug 13, 2020
    yapi
    bluehtt
        19
    bluehtt  
       Aug 14, 2020 via iPhone
    yapi
    uxstone
        20
    uxstone  
       Aug 14, 2020
    yapi
    edk24
        21
    edk24  
       Aug 14, 2020
    我们本地鸡用的 yapi
    balabalaguguji
        22
    balabalaguguji  
       Aug 14, 2020
    monkeyWie
        23
    monkeyWie  
    OP
       Aug 14, 2020
    @balabalaguguji 注意是私有部署哦🐶
    balabalaguguji
        24
    balabalaguguji  
       Aug 14, 2020
    @monkeyWie 支持私有部署,不过没开源,免费的已经很够用
    monkeyWie
        25
    monkeyWie  
    OP
       Aug 14, 2020
    @balabalaguguji 好吧,还有一个很重要的好像不支持导入 swagger
    balabalaguguji
        26
    balabalaguguji  
       Aug 14, 2020
    @monkeyWie 支持 swagger,postman 。而且接口测试也是支持,还能一键生成文档、Mock 。
    hpu423
        27
    hpu423  
       Aug 14, 2020
    apifox
    okampfer
        28
    okampfer  
       Aug 14, 2020 via Android
    各位同仁,yapi 是不是有一阵子没更新了?
    MarioLuo
        29
    MarioLuo  
       Sep 10, 2021
    [烟花][烟花][烟花]
    给大家推荐个 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
       Sep 10, 2021
    @MarioLuo 一定要通过 IDEA 插件生成吗,我们现在做的是提交代码的时候文档自动化生成,这个能实现吗
    MarioLuo
        31
    MarioLuo  
       Sep 10, 2021
    不支持集成到自动化,不过手动上传也就秒秒钟的事,如果你要自动化可以考虑 smart-doc 这个工具, 但是好像不支持 YApi, Rap2 之类
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   1504 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 66ms · UTC 16:38 · PVG 00:38 · LAX 09:38 · JFK 12:38
    ♥ Do have faith in what you're doing.