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

由于模型文档管理混乱,我自己开发并开源了一款在线数据库文档管理平台

  •  
  •   vbridge · 2022-04-10 12:28:11 +08:00 · 1866 次点击
    这是一个创建于 950 天前的主题,其中的信息可能已经有所发展或是发生改变。

    在软件行业,API 文档的自动化有着非常广泛而成熟的方案,但数据库模型文档的自动化却还是一片蓝海。

    鉴于此,我就自己开发了一款面向团队的数据库文档管理平台 Databasir 。

    项目地址: https://github.com/vran-dev/databasir

    文档地址: https://doc.databasir.com

    特性

    1. 支持所有拥有 JDBC 驱动的关系型数据库,自动将数据库字段转成文档
    2. 集成了 github / gitlab 的 oauth 登录
    3. 支持模型 markdown 文档导出、UML 图片导出
    4. 支持多版本管理,一键即可查看版本差异
    5. 支持 Mock Insert SQL 生成,通过定义依赖关系可以自动生成多表关联 SQL

    反馈

    如果有任何使用上的问题或者更好的 feature 可以通过 https://github.com/vran-dev/databasir/issues 提出 issue 给我

    第 1 条附言  ·  2022-04-22 13:46:36 +08:00

    Hi,大家好,懒是第一生产力,项目的初衷就是为了能够自动生成数据库的模型文档,能够在数据库模型有变更时自动通知相关业务人员,让我专注于 coding(moyu)。

    上个版本 release 后收到了不少建议,90% 都已经在这个版本中完成了,尤其是大家反馈最多的的搜索与注释功能,话不多说,直接进入主题

    v1.0.2 发布内容

    功能

    • feature;UML 图片导出支持 svg 格式
    • feature;表目录列表支持按表名、注释名搜索
    • feature;表文档页面新增注释展示
    • feature;数据库扩展支持自动获取驱动类名
    • feature:数据库元数据同步采用异步任务设计,解决大数据量同步超时问题
    • feature:文档内容采用分组加载,解决大数据量加载超时问题
    • feature:文档默认模板统一改为中文

    安全

    • security:对上传的驱动 jar 包新增规则校验
    • security:采用可配置(默认随机)的 jwt token secret

    预览

    sync.gif

    1 条回复    2022-04-10 12:35:37 +08:00
    adoal
        1
    adoal  
       2022-04-10 12:35:37 +08:00
    膜拜大牛
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2812 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 11:42 · PVG 19:42 · LAX 03:42 · JFK 06:42
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.