InnerPeace715
V2EX  ›  问与答

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

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

    https://www.apifox.cn/
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1914 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 84ms · UTC 07:57 · PVG 15:57 · LAX 23:57 · JFK 02:57
    ♥ Do have faith in what you're doing.