• 请不要在回答技术问题时复制粘贴 AI 生成的内容
dfjslkjdf
V2EX  ›  程序员

大家分享一下 API 文档管理工具?

  •  1
     
  •   dfjslkjdf · Apr 29, 2019 · 11424 views
    This topic created in 2751 days ago, the information mentioned may be changed or developed.

    大家一般都用什么 API 文档管理工具?
    分享一下。

    我一般主要使用 mac 上的 Dash,不过还有两个缺点:

    • 不好直接修改文档
    • 图片不好存储。 有类似的问题吗,怎么解决呢?

    23 replies  •  2021-07-10 00:29:32 +08:00
    TommyLemon
    TommyLemon
    Apr 29, 2019
    1

    自动查数据库表和字段属性,生成数据字典文档。
    自动给请求 JSON 加注释,自动给返回结果 JSON 光标悬停显示注释。


    一键全自动化接口回归测试,不用写任何代码,不用做任何配置。

    APIJSONAuto-自动化接口管理工具,自动生成代码、自动静态检查、自动化回归测试、自动生成文档与注释等。
    GitHub 右上角点 Star 支持下吧 ^_^
    https://github.com/TommyLemon/APIJSONAuto/
    TommyLemon
    TommyLemon
    Apr 29, 2019
    2
    @TommyLemon 还支持多账户,自由添加和切换使用
    kkjinping
    kkjinping
    Apr 29, 2019
    3
    swagger
    ooee2016
    ooee2016
    Apr 29, 2019
    4
    eolinker
    luosuosile
    luosuosile
    Apr 29, 2019
    5
    swagger +1
    jeremysss
    jeremysss
    Apr 29, 2019
    6
    去哪儿的 YAPI,Node + React 写的,有源码可以拉下来自己改,支持本地部署,8000+ star https://github.com/YMFE/yapi
    TommyLemon
    TommyLemon
    Apr 29, 2019
    7
    @kkjinping @ooee2016 @luosuosile
    APIJSONAuto 比 Swagger 强大易用很多哦
    https://github.com/TommyLemon/APIJSON/issues/27
    sunjourney
    sunjourney
    Apr 29, 2019
    8
    swagger
    my101du
    my101du
    Apr 29, 2019 via Android
    9
    提问者多写了个 API, 回答者只看了个 API...
    dfjslkjdf
    dfjslkjdf
    OP
    Apr 29, 2019
    10
    @my101du
    没事,有内容的回答都欢迎。
    ilay1678
    ilay1678
    Apr 29, 2019 via Android
    11
    可以试试 showdoc
    AngryPanda
    AngryPanda
    Apr 29, 2019 via Android
    12
    yapi 的确不错
    daodao116
    daodao116
    Apr 30, 2019
    13
    swagger
    TommyLemon
    TommyLemon
    Apr 30, 2019
    14
    skiy
    skiy
    Apr 30, 2019
    15
    https://github.com/lifei6671/mindoc

    https://www.iminho.me/

    MinDoc 是一款针对 IT 团队开发的简单好用的文档管理系统。

    MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用,同时增加 Markdown 和 HTML 两种编辑器。

    Go 项目

    ---------------------------------------------------------------------------------------------
    https://github.com/EhsanTang/ApiManager

    http://api.crap.cn

    一个由免费开源的 API 接口、文档管理系统(应用接口管理系统)

    Java 项目

    ---------------------------------------------------------------------------------------------
    ......等等
    skiy
    skiy
    Apr 30, 2019
    16
    不过楼主的可能搞糊涂了。
    Dash 不算是 API 文档管理工具吧?
    应该是文档管理工具。
    skiy
    skiy
    Apr 30, 2019
    17
    Zeal 这款用过,虽然跟 Dash 有点差距,但类似。跨平台的,挺好用。
    dfjslkjdf
    dfjslkjdf
    OP
    Apr 30, 2019
    18
    @skiy
    Dash is an API Documentation Browser and Code Snippet Manager.
    主要就是管理 api 和 代码片段。
    7sDream
    7sDream
    Apr 30, 2019
    19
    devdocs,不过好像修改不是很方便。

    https://devdocs.io/
    wwwn
    wwwn
    Apr 30, 2019
    20
    swagger
    balabalaguguji
    balabalaguguji
    Oct 30, 2019
    21
    易文档,接口文档、在线测试,还能一键生成 mock,一键生成文档: https://easydoc.top
    andychen1
    andychen1
    Sep 4, 2020
    22
    试试在线的 api-mom
    jessezhang1986
    jessezhang1986
    Jul 10, 2021
    23
    推荐牛逼的 Apifox,API 文档、调试、Mock 、测试一体化协作平台,差不多是 Postman + Swagger + Mock + JMeter,https://www.apifox.cn/
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1134 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 69ms · UTC 23:23 · PVG 07:23 · LAX 15:23 · JFK 18:23
    ♥ Do have faith in what you're doing.