V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
InnerPeace715
V2EX  ›  问与答

有木有靠谱的 API 文档管理工具推荐一下?

  •  
  •   InnerPeace715 · 2020-01-16 09:25:30 +08:00 · 3641 次点击
    这是一个创建于 992 天前的主题,其中的信息可能已经有所发展或是发生改变。
    22 条回复    2021-12-18 16:12:47 +08:00
    zxfreedom
        1
    zxfreedom  
       2020-01-16 09:34:53 +08:00
    rap 了解一些
    bot2020
        2
    bot2020  
       2020-01-16 09:49:45 +08:00
    swagger/openapi
    ifconfig
        3
    ifconfig  
       2020-01-16 09:55:27 +08:00
    EoLinker 用了都回不去
    cedoo22
        4
    cedoo22  
       2020-01-16 09:55:42 +08:00
    swagger/openapi 基于注解 生成元数据,依赖 swagger api.
    不想依赖的话,找 github 开源的,像 smart-doc 这样的,从注释 生成。
    kyuuseiryuu
        5
    kyuuseiryuu  
       2020-01-16 10:25:05 +08:00   ❤️ 1
    上班这么久,感觉啥 API 管理工具都没用。
    最终都会变成“后端从代码生成 API 文档给前端查”。
    因为后端不想自己去设计 API、写文档,觉得都已经写代码了,直接生成就好了。
    也不愿意其他岗位设计 API 然后去实现每个 HTTP 接口。
    没能从行政手段上要求接口先行的,啥 API 管理工具都没用。
    liuzhaowei55
        6
    liuzhaowei55  
       2020-01-16 10:36:40 +08:00
    基于 openapi 的 swagger。
    现在是手写 openapi.yml 其他基于注释,注解生成的也尝试过,感觉有一定的侵入性,结构上相比生成的也更加简洁一些。
    缺点就是代码更新后要手动更新 yml 文件,有滞后性。
    不过技术也不是万能的啥问题都能解决,总是需要一些其他手段来辅助才行。
    balabalaguguji
        7
    balabalaguguji  
       2020-01-16 10:41:21 +08:00
    易文档,很靠谱,easydoc.top
    InnerPeace715
        8
    InnerPeace715  
    OP
       2020-01-16 10:41:23 +08:00
    @kyuuseiryuu 真实 23333
    6167
        9
    6167  
       2020-01-16 11:11:47 +08:00
    showdoc
    MYlyc
        10
    MYlyc  
       2020-01-16 11:37:39 +08:00
    jianyan74
        11
    jianyan74  
       2020-01-16 13:12:23 +08:00
    fanpei0121
        12
    fanpei0121  
       2020-01-16 13:39:26 +08:00
    UserNameisNull
        13
    UserNameisNull  
       2020-01-16 15:23:00 +08:00
    @zxfreedom yapi 了解一下
    star7th
        14
    star7th  
       2020-01-16 15:27:01 +08:00
    showdoc 挺简单好用的,可以试下 github.com/star7th/showdoc
    ChoateYao
        15
    ChoateYao  
       2020-01-16 15:34:42 +08:00
    @fanpei0121 这个很垃圾,一次性把所有接口文档都返回了,每次打开一个项目就要卡半天,项目越大卡的时间越久。
    InnerPeace715
        16
    InnerPeace715  
    OP
       2020-01-17 09:27:32 +08:00
    @star7th 我也看过,,功能还可以,就是觉得界面有点简陋。。我是看脸的人。2333
    takatost
        17
    takatost  
       2020-01-17 09:35:00 +08:00
    上次看到 v 站广告推的 coding 的 API 文档,对于我们这种代码直接生成的还挺香的,就是自己配自动生成还有点麻烦。。没错,我就是看颜值的人[doge][doge]
    InnerPeace715
        18
    InnerPeace715  
    OP
       2020-01-17 09:35:35 +08:00
    @jianyan74 优秀。。。
    InnerPeace715
        19
    InnerPeace715  
    OP
       2020-01-17 09:36:18 +08:00
    @takatost 同道同道。。
    star7th
        20
    star7th  
       2020-01-17 10:58:55 +08:00
    @InnerPeace715 见仁见智。很多人喜欢这种简洁风的。已经累积不少用户了。
    andychen1
        21
    andychen1  
       2020-09-04 14:27:25 +08:00
    不要问,问就 www.api-mom.com
    apifox
        22
    apifox  
       290 天前
    Apifox 了解下,Apifox 是 API 文档、API 调试、API Mock 、API 自动化测试一体化协作平台,定位 Postman + Swagger + Mock + JMeter 。

    https://www.apifox.cn/
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   1448 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 41ms · UTC 17:13 · PVG 01:13 · LAX 10:13 · JFK 13:13
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.