V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
zhuwd
V2EX  ›  程序员

求推荐比较好用的接口文档管理工具?

  •  1
     
  •   zhuwd · 97 天前 · 3706 次点击
    这是一个创建于 97 天前的主题,其中的信息可能已经有所发展或是发生改变。
    主要有两个场景:1.团队内部使用; 2.接口文档导出给第三方对接平台
    41 条回复    2022-07-07 20:10:17 +08:00
    iamfei666
        1
    iamfei666  
       97 天前
    语雀
    dayeye2006199
        2
    dayeye2006199  
       97 天前
    注释
    yekern
        3
    yekern  
       97 天前
    Apifox 或者 Apipost 直接调试 然后网页访问文档 还能加密
    THESDZ
        4
    THESDZ  
       97 天前
    个人建议是找个支持 openapi(swagger3)导入的框架
    THESDZ
        5
    THESDZ  
       97 天前   ❤️ 1
    @THESDZ
    优势是:1.代码即文档,减少工作量。2.标准格式外部工具很多,例如导出 word ,pdf ,markdown ;生成 sdk 等。
    mengdodo
        6
    mengdodo  
       97 天前
    showdoc
    oyp
        7
    oyp  
       97 天前
    直接手写 Word
    waising
        8
    waising  
       97 天前
    手动录入 yapi
    oyp
        9
    oyp  
       97 天前
    我用 wolai 编辑 API 文档,不用想那么多,写起来贼流畅。虽然不能直接运行(我手动运行一样的)和不能自动生成结构(把返回的数据粘贴过去,看 JSO 也能看出来,没必要生成)

    图 1:s3.bmp.ovh/imgs/2022/06/28/7334b6845b8fd612.png
    图 2:s3.bmp.ovh/imgs/2022/06/28/7e83681e49b8c241.png
    xuxuzhaozhao
        10
    xuxuzhaozhao  
       97 天前
    非常推荐使用 ApiPost
    DavidDee
        11
    DavidDee  
       97 天前
    yapi,rap2
    jmllx1963
        12
    jmllx1963  
       97 天前
    apifox 可以通过 URL 直接导入 openAPI3 的接口和数据模型 还是很方便的
    abc0123xyz
        13
    abc0123xyz  
       97 天前
    别写什么文档注释,提高竞争力,防止被优化(狗头)
    carrie96
        14
    carrie96  
       97 天前
    yapi ? swagger ?
    d119
        15
    d119  
       97 天前
    postman 不也可以吗
    linauror
        16
    linauror  
       97 天前
    个人目前用的比较爽的是用注释导出 swagger ,然后 yapi 自动定时同步 swagger.json (手工导入会导致结构错乱,不知道咋回事)
    ychost
        17
    ychost  
       97 天前
    ApiPost 好用,还能一键生成 HTML/Markdown 文档,唯一不爽的就是老是在更新!
    flowerains
        18
    flowerains  
       97 天前
    Apifox ,apiPost

    但是从团队协作的程度上来看我觉得 eolink 更有潜力
    wolfie
        19
    wolfie  
       97 天前
    showdoc ,导出不太方便(可能版本问题)。/t/842583

    _都不用 ApiPost ,可以搜一搜过去在 v2 上的恶心推广。
    balabalaguguji
        20
    balabalaguguji  
       97 天前
    不废话,看效果先: https://easydoc.net/s/17790664/CZMqMhfW/78558034
    还可以做手册,自定义域名,看效果: https://k8s.easydoc.net

    官网: https://easydoc.net
    jayin
        21
    jayin  
       97 天前
    apifox
    southsala
        22
    southsala  
       97 天前
    月经贴,能选择的就那么几个,yapi 、swagger 、showdoc 、apifox
    balabalaguguji
        23
    balabalaguguji  
       97 天前
    @southsala #22 你不试下易文档,个人觉得比你说的这几个都好太多了
    guanhui07
        24
    guanhui07  
       97 天前
    yapi 、swagger 、showdoc 、apifox
    2696284032
        25
    2696284032  
       97 天前
    eolink 是我用过最好用的
    legiorange
        26
    legiorange  
       97 天前   ❤️ 1
    强推 swagger+postman.
    swagger 非常方便本地调试,如果团队一起维护一个 postman ,说实话体验是真的不错。
    在大型系统中用 postman 的话比单纯使用 swagger 要舒服,正式环境我会关闭 swagger ,使用 postman 调。apipost 和 apifox 我都用过,公司也掏钱了,实际体验并没有 postman 丝滑,可能和我个人习惯有关系。
    语雀和 wolai 都是在线的文档,考虑到隐私性我放弃了使用。
    v2eb
        27
    v2eb  
       97 天前 via Android
    knif4j
    xsen
        28
    xsen  
       97 天前
    yapi
    sutra
        29
    sutra  
       97 天前
    nekoneko
        30
    nekoneko  
       97 天前
    showdoc
    不能自己部署服务端的接口文档工具都是垃圾
    ixinshang
        31
    ixinshang  
       97 天前
    showdoc
    Saxton
        32
    Saxton  
       97 天前
    Apifox 一直在用,缺点就是每个版本新加的功能很多,但改动也很大
    CathayChen
        33
    CathayChen  
       97 天前
    alen0206
        34
    alen0206  
       97 天前
    yapi
    securityCoding
        35
    securityCoding  
       97 天前 via Android
    pb
    jeffh
        36
    jeffh  
       97 天前
    必须 yapi ,搭配 idea 插件,神一般的存在
    gclm
        37
    gclm  
       97 天前 via Android
    @linauror 如何用注解生成 swagger.json 啊,能否分享一下呢?目前感觉你这个方法很棒
    linauror
        38
    linauror  
       96 天前
    @gclm 如果你用的 golang 的话,可以结合 swaggo ,直接引用结构体和注释来生成 swagger.json ,其他语言应该也有类似的生成工具
    cubecube
        39
    cubecube  
       96 天前
    @THESDZ 很多接口并不能用 openapi 表示呢
    wm5d8b
        40
    wm5d8b  
       96 天前 via Android
    接口文档工具默认就是 HTTP 吗,dubbo 和 grpc 的怎么维护
    howaworld
        41
    howaworld  
       88 天前
    apipost 不错,尤其对新手来说,很容易上手,我带的新人一下午就能搞明白。
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   864 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 47ms · UTC 21:25 · PVG 05:25 · LAX 14:25 · JFK 17:25
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.