V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
star7th
V2EX  ›  分享创造

ShowDoc v2.8.14 发布, IT 团队的在线 API 文档、技术文档工具

  •  
  •   star7th · 234 天前 · 1880 次点击
    这是一个创建于 234 天前的主题,其中的信息可能已经有所发展或是发生改变。

    地址

    开源地址: https://github.com/star7th/showdoc

    官网: https://www.showdoc.com.cn/

    本版本更新内容:

    1, 支持跨项目复制和移动目录以及目录下的文档

    2, mock 功能前缀固定,后缀可以自定义 url 路径

    3, 页面的历史版本可以编辑备注信息,方便自己备注版本差异

    4, 关闭浏览器时候将自动解除锁定页面编辑的状态

    5, 修复长项目标题引起的 bug

    更新步骤请参考 请参考手册的升级安装部分 : https://www.showdoc.com.cn/help?page_id=13732

    showdoc 介绍

    ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版 ( github8700+ star ) 。通过 showdoc,你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档,你还可以利用 showdoc 的自动化能力,从程序注释中自动生成 API 文档,或者从搭配的 RunApi 客户端(类似 postman 的 api 调试工具)中一边调试接口 、一 边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc 还支持多平台客户端,有 win 客户端、mac 客户端、ios 、android 等,更方便跨平台使用。目前超过 100000+的互联网团队正在使用 showdoc,包括知名公司内部的一些团队, 比如腾讯、华为、百度、京东、字节跳动等等。

    关于 Showdoc 的详细介绍,请看: https://www.showdoc.com.cn/help

    26 条回复    2021-04-13 15:49:28 +08:00
    yushiro
        1
    yushiro  
       234 天前 via iPhone
    支持一下。曾经用过,挺方便的,但后来重心转移到 postwoman 去了。
    star7th
        2
    star7th  
    OP
       234 天前
    @yushiro postwoman 是挺棒的。不过也可以考虑用 runapi 跟 showdoc 无缝集成接口调试 https://www.showdoc.com.cn/runapi?page_id=30291
    LeslieLeung
        3
    LeslieLeung  
       234 天前 via iPhone
    看到是 php 的项目有点激动,但是看到是 tp3 就有点那啥了..我对 tp5tp6 比较熟悉,tp3 属实太旧了
    star7th
        4
    star7th  
    OP
       233 天前
    @LeslieLeung 用这个框架完全是出于兼容的考虑。可以兼容到 php5.3 。而如果要用现代框架重写,肯定是用 laravel 。但那个对版本要求太高了,不利于代码分发。现在主流的系统之一 centos7 的默认 php 环境还是 5.4 。 为了这个兼容性,我还是不会升级。再过几年再重写吧。
    star7th
        5
    star7th  
    OP
       233 天前
    @LeslieLeung 另外说一下就是这个框架目前我自维护了,安全以及其他特性都是我加入。它目前兼容从 php5.3 到 php8,兼容性是最好的,利于做代码分发。这一点比用现代框架强。过几年就再用 laravel 重写。
    LeslieLeung
        6
    LeslieLeung  
       233 天前 via iPhone
    @star7th #5 我目前在用 yapi,那个目前不能用最新版的 postman 导入接口了,考虑换用 showdoc 。另外我本身写 php 比较多,难得见到 php 的项目,希望有机会贡献一点代码。
    endershadow
        7
    endershadow  
       233 天前
    挺棒的,内网已经部署 showdoc
    但是 runapi 不支持内网部署
    star7th
        8
    star7th  
    OP
       233 天前
    @LeslieLeung yapi 的作者自从离开原公司后,yapi 这个项目就基本停止维护了。如果后面有爆出什么安全漏洞的话估计也没人修复。建议还是尽早换到持续维护的项目上来吧。目前我写了 runapi 准备补充 showdoc 本身在接口调试方面的缺乏 https://www.showdoc.com.cn/runapi?page_id=30291 某种程度上是可以替换 postman 和 yapi 的
    star7th
        9
    star7th  
    OP
       233 天前
    @endershadow runapi 本质是用 web 技术写的 win 客户端。需要网络支持,目前尚未支持离线版。
    LeslieLeung
        10
    LeslieLeung  
       233 天前 via iPhone
    @star7th #8 如果能支持一下 postman 导入就更好了?
    star7th
        11
    star7th  
    OP
       233 天前
    @LeslieLeung showdoc 和 runapi 都是支持的。showdoc 上是新建项目-从文件导入。runapi 直接选择导入
    agdhole
        12
    agdhole  
       233 天前 via iPhone
    php7.3 马上都要停止维护了
    star7th
        13
    star7th  
    OP
       233 天前
    @agdhole 这就是我很讨厌的社区割裂感。现在的情况是主流系统之一的 centos7 都还在使用默认的 php5.4 。我不能放弃这块群体的。对于 php 开发者而言,什么版本都不是问题。但 showdoc 的大部分用户都是非 php 开发者,都是产品使用者。他们安装的时候就需要便利。这种时候我不能随便上高版本的 php 。只是说,我改写了程序,让其支持到了 php8.但不能强制要求那么高版本的。
    Leonard
        14
    Leonard  
       233 天前
    用过,支持一下
    star7th
        15
    star7th  
    OP
       233 天前
    @agdhole 如果是做 sdk 之类的,面向 php 领域的开发者,那么版本高也可以。如果是作为产品暴露出去给用户,那么我坚持产品的易用性和易安装性大于一切。需要向后兼容。
    yanzhiling2001
        16
    yanzhiling2001  
       233 天前
    正是由于各种环境版本导致社区割裂感,docker 的作用才那么及时珍贵
    star7th
        17
    star7th  
    OP
       233 天前
    @yanzhiling2001 是的,docker 的存在太有必要的。所以 showdoc 也提供 docker 版本的安装 https://www.showdoc.com.cn/help?page_id=65610 ,docker 确实为很多跨语言开发者提供了便利。
    LeslieLeung
        18
    LeslieLeung  
       233 天前 via iPhone
    @star7th #11 只能在新建项目的时候导入吗?每次导入都要新建一个项目吗?
    star7th
        19
    star7th  
    OP
       233 天前
    @LeslieLeung 现在是的。但后面有计划做一个项目内导入的功能。
    xiaobanlong
        20
    xiaobanlong  
       233 天前
    之前有了解过, 好像不支持 swagger 注解? 最后选择了 knife4j
    star7th
        21
    star7th  
    OP
       233 天前
    @xiaobanlong 如果是说用注释来生产文档的话,showdoc 有一套自己的语法可以自动从注释生成文档 https://www.showdoc.com.cn/page/741656402509783
    mangosong
        22
    mangosong  
       233 天前
    在用 支持一下
    rekulas
        23
    rekulas  
       233 天前
    发现一个 clue,首页针对用户和爬虫访问做了区分展示
    star7th
        24
    star7th  
    OP
       233 天前
    @rekulas 主要是为了被搜索引擎收录。目前发现谷歌搜索索引得还好,百度一般般。
    zibber
        25
    zibber  
       233 天前
    docker 升级都要迁移数据库,可以改的平滑一点
    star7th
        26
    star7th  
    OP
       232 天前
    @zibber showdoc 的所有升级方式都是“先安装新版程序再迁移数据库”,这样能避免很多包袱问题,比如说要考虑到旧文件是不是修改过等兼容问题。如果采用我说的这种方式,完全不用考虑这种历史问题。对于想平滑操作的用户,我有提供一键操作脚本的。不使用一键脚本的用户可能就需要多执行一点命令了。
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   3052 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 04:46 · PVG 12:46 · LAX 20:46 · JFK 23:46
    ♥ Do have faith in what you're doing.