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

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

  •  
  •   star7th · 2022-01-10 09:37:29 +08:00 · 3734 次点击
    这是一个创建于 1030 天前的主题,其中的信息可能已经有所发展或是发生改变。

    地址

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

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

    更新内容:

    1 ,安全更新

    2 ,增加页面修改提醒功能,可通知指定的项目成员

    3 ,增加项目变更记录功能(查看入口在项目主页的右侧工具栏的更多展开按钮中)

    4 ,可以导入文件(postman/swagger/markdown 压缩包)到已存在的项目内,也可以重复导入以覆盖更新

    5 ,优化注释生成文档功能

    6 ,支持通过 s3 协议上传附件

    更之前的一些版本更新汇总

    1 ,修复导入 swagger 文件的问题

    2 ,修复点击文件库错误的问题

    3 ,支持 runapi 客户端的错误返回示例

    4 ,支持 runapi 客户端的搜索功能

    5 ,支持 runapi 客户端的 query 和路径变量功能

    6 ,可一键设置团队的成员项目权限为只读

    7 ,选择目录时候可输入关键字搜索目录

    8 ,在编辑页面时候可跳转去新建目录

    9 ,完善页面排序功能

    10 ,修复 xss 安全漏洞

    11 ,解决 TOC 目录遮挡图标的问题

    12 ,支持 runapi 客户端的接口状态功能

    13 ,支持 runapi 客户端的全局 cookies 功能

    14 ,支持 runapi 客户端的全局脚本功能

    如何操作

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

    介绍

    ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版( github 1 万+ 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

    17 条回复    2022-01-14 08:50:27 +08:00
    lupkcd
        1
    lupkcd  
       2022-01-10 10:22:09 +08:00
    使用过支持一下
    nekoneko
        2
    nekoneko  
       2022-01-10 10:47:33 +08:00
    一直在用支持一下
    ScotGu
        3
    ScotGu  
       2022-01-10 11:18:00 +08:00
    一直在用, 必须支持。
    但是有个问题想反馈下,
    在电子表格项目中,选中部分表格后复制后无法粘贴在记事本或者 excel 中。
    PickMio
        4
    PickMio  
       2022-01-10 11:55:26 +08:00
    一直在用, 很不错, 就是希望提供 mysql 的存储方式. sqlite 打开的时候和添加新内容时写入比较慢... 也经常卡死需要刷新
    star7th
        5
    star7th  
    OP
       2022-01-10 12:12:16 +08:00
    @ScotGu 这个后面看下
    star7th
        6
    star7th  
    OP
       2022-01-10 12:14:47 +08:00
    @PickMio showdoc sqlite 用了那么多年第一次听说会卡死需要刷新的。你可以把你的情况说下,比如说大概写多少数据的时候有问题,安装在什么服务器上
    PickMio
        7
    PickMio  
       2022-01-10 13:32:20 +08:00
    @star7th #6 按照你说的, 我又去测试了一下, 发现打不开的情况是挂了代理的时候有请求失败 , 关闭代理再访问就正常了, 而且写入也很快
    mekingname
        8
    mekingname  
       2022-01-10 13:58:10 +08:00
    我来找个茬。为什么历史版本的 icon 是手提包?![]( https://kingname-1257411235.cos.ap-chengdu.myqcloud.com/20220110135805.png)
    star7th
        9
    star7th  
    OP
       2022-01-10 14:10:30 +08:00
    @mekingname 用的是这个框架的内置图标 https://element.eleme.cn/#/zh-CN/component/icon 我发现没什么好的图标可以用作为历史版本的标识了
    q474818917
        10
    q474818917  
       2022-01-10 19:54:27 +08:00
    ui 还不够美观
    googlehub
        11
    googlehub  
       2022-01-10 21:45:28 +08:00
    昨天还吐槽了,写的文档能搜索出来的。
    star7th
        12
    star7th  
    OP
       2022-01-10 23:00:23 +08:00
    @googlehub 你是说搜索引擎收录?公开文档是会被收录的,就像你在 v2 的一篇公开帖子。私有项目则不会被收录。并且默认新建文档的时候选择的是私有文档。一般要设置公开的都是用户自己操作的
    geniusmyn
        13
    geniusmyn  
       2022-01-11 10:05:42 +08:00
    一直在用支持一下
    liaohongxing
        14
    liaohongxing  
       2022-01-13 16:49:04 +08:00
    后端居然是大 PHP
    liaohongxing
        15
    liaohongxing  
       2022-01-13 16:51:23 +08:00
    免费版限制比 apipost 的多 。薅羊毛可能处于劣势
    star7th
        16
    star7th  
    OP
       2022-01-13 19:46:13 +08:00
    @liaohongxing 这个免费版的限制只是官网的使用配额限制。开源版不会有这些限制。如果是抱着薅羊毛的想法,为何不用完全免费的开源版。官网是给有需要的企业用的
    liaohongxing
        17
    liaohongxing  
       2022-01-14 08:50:27 +08:00
    @star7th 抱歉 ,没仔细看 。以为没有开源版。像您开源的行为致敬
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3437 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 04:55 · PVG 12:55 · LAX 20:55 · JFK 23:55
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.