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

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

  •  1
     
  •   dfjslkjdf · 2019-04-29 16:26:43 +08:00 · 8698 次点击
    这是一个创建于 1118 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

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

    23 条回复    2021-07-10 00:29:32 +08:00
    TommyLemon
        1
    TommyLemon  
       2019-04-29 17:47:01 +08:00

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


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

    APIJSONAuto-自动化接口管理工具,自动生成代码、自动静态检查、自动化回归测试、自动生成文档与注释等。
    GitHub 右上角点 Star 支持下吧 ^_^
    https://github.com/TommyLemon/APIJSONAuto/
    TommyLemon
        2
    TommyLemon  
       2019-04-29 17:47:46 +08:00
    @TommyLemon 还支持多账户,自由添加和切换使用
    kkjinping
        3
    kkjinping  
       2019-04-29 17:51:36 +08:00
    swagger
    ooee2016
        4
    ooee2016  
       2019-04-29 17:53:29 +08:00
    eolinker
    luosuosile
        5
    luosuosile  
       2019-04-29 17:56:13 +08:00
    swagger +1
    jeremysss
        6
    jeremysss  
       2019-04-29 18:04:01 +08:00
    去哪儿的 YAPI,Node + React 写的,有源码可以拉下来自己改,支持本地部署,8000+ star https://github.com/YMFE/yapi
    TommyLemon
        7
    TommyLemon  
       2019-04-29 18:08:05 +08:00
    @kkjinping @ooee2016 @luosuosile
    APIJSONAuto 比 Swagger 强大易用很多哦
    https://github.com/TommyLemon/APIJSON/issues/27
    sunjourney
        8
    sunjourney  
       2019-04-29 18:08:43 +08:00
    swagger
    my101du
        9
    my101du  
       2019-04-29 18:44:53 +08:00 via Android
    提问者多写了个 API, 回答者只看了个 API...
    dfjslkjdf
        10
    dfjslkjdf  
    OP
       2019-04-29 18:47:22 +08:00
    @my101du
    没事,有内容的回答都欢迎。
    ifwangs
        11
    ifwangs  
       2019-04-29 19:51:04 +08:00 via Android
    可以试试 showdoc
    AngryPanda
        12
    AngryPanda  
       2019-04-29 19:53:02 +08:00 via Android
    yapi 的确不错
    daodao116
        13
    daodao116  
       2019-04-30 09:11:44 +08:00
    swagger
    TommyLemon
        14
    TommyLemon  
       2019-04-30 10:20:01 +08:00
    skiy
        15
    skiy  
       2019-04-30 10:56:52 +08:00
    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
        16
    skiy  
       2019-04-30 11:00:22 +08:00
    不过楼主的可能搞糊涂了。
    Dash 不算是 API 文档管理工具吧?
    应该是文档管理工具。
    skiy
        17
    skiy  
       2019-04-30 11:02:41 +08:00
    Zeal 这款用过,虽然跟 Dash 有点差距,但类似。跨平台的,挺好用。
    dfjslkjdf
        18
    dfjslkjdf  
    OP
       2019-04-30 11:06:53 +08:00
    @skiy
    Dash is an API Documentation Browser and Code Snippet Manager.
    主要就是管理 api 和 代码片段。
    7sDream
        19
    7sDream  
       2019-04-30 13:16:13 +08:00
    devdocs,不过好像修改不是很方便。

    https://devdocs.io/
    wwwn
        20
    wwwn  
       2019-04-30 15:43:52 +08:00
    swagger
    balabalaguguji
        21
    balabalaguguji  
       2019-10-30 18:46:07 +08:00
    易文档,接口文档、在线测试,还能一键生成 mock,一键生成文档: https://easydoc.top
    andychen1
        22
    andychen1  
       2020-09-04 14:30:36 +08:00
    试试在线的 api-mom
    jessezhang1986
        23
    jessezhang1986  
       316 天前
    推荐牛逼的 Apifox,API 文档、调试、Mock 、测试一体化协作平台,差不多是 Postman + Swagger + Mock + JMeter,https://www.apifox.cn/
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   2402 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 05:31 · PVG 13:31 · LAX 22:31 · JFK 01:31
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.