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

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

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

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

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

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

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

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


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

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

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