程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

以下为你介绍的程序文档工具都可用在Linux系统上:pandocGUI(pandoc 可视化界面)、zyplayer-doc(通用文档管理工具)、database-doc-generator(数据库文档生成器:生成markdown文档)。

1、pandocGUI(pandoc 可视化界面)

这是一个 pandoc 的 GUI 前端,适用于 windows,在 VS2013 Express 版上用 c# 编写。

我希望这个工具可以让人在 windows 上更轻松地使用 pandoc。

可以实现 markdown 文件转 docx 和 html 等格式。

这个软件是跨平台支持的,当然你也可以在 Linux 下用 wine 运行它。

下载地址:https://gitee.com/mirrors/pandocGUI

2、zyplayer-doc(通用文档管理工具)

zyplayer-doc项目介绍:

定位为所有文档的管理项目,swagger文档、数据库文档....等,提供一整套的解决方案,欢迎有想法的一起来写。

软件架构:

一、zyplayer-doc-core 一些核心、公用的类

二、zyplayer-doc-db 数据库文档

原zyplayer-doc-db,具有数据库文档的查看、管理、导出等功能。

三、zyplayer-doc-manage 可以单独部署的文档管理后台

后端使用spring-boot、mybatis-plus、springfox-swagger等框架,前端使用zui、Vue等框架。

已集成三套优秀swagger文档前端:zyplayer-doc-swagger、swagger-bootstrap-ui、springfox-swagger-ui。

已集成zyplayer-doc-db数据库文档。

四、zyplayer-doc-swagger 原swagger-mg-ui,swagger的UI及整套解决方案

具有后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能,不止UI。

运行方式:

创建数据库:zyplayer_doc_manage,执行脚本:zyplayer_doc_manage.sql。

修改zyplayer-doc-manage项目的application.yml配置文件里面的数据库账号密码。

启动zyplayer-doc-manage项目,访问地址:http://127.0.0.1:8082/zyplayer-doc-manage/statics/manage/home.html。

功能介绍:

一、zyplayer-doc-swagger

在 zyplayer-doc-swagger->文档管理->文档地址管理 页可以管理任意地址的文档,在集成的三套UI中都可以直接查看和调试这里配置的文档,不用对UI做任何调整,只要标准的UI集成进来也可以直接用。

文档展示配置,自动填充请求参数:可配置填充级别,强制重写域名:文档在本地想调试线上接口的好帮手,自动保存请求参数:不用每次输入。

可配置全局参数,放在header或param里的。

可对调试数据进行管理。

模拟返回:前端自行调试接口的好帮手。

私人强迫症级定制化文档展示,清晰明了,参数支持批量编辑,每一条线的间距都考量了半天,支持文件上传的调试,需要指定dataType = File或MultipartFile,例:@ApiImplicitParam(name = "file", value = "文件", dataType = "File", allowMultiple = true)。

后端代理请求,后端存储,不会存在任何跨域问题。

二、zyplayer-doc-db

支持Mysql、SQLserver的数据库表、字段文档查看修改,导出,展示关系图等功能。

支持多数据源,在zyplayer-doc-manage -> application.yml -> zyplayer.doc.db.dbConfigList 处配置多个数据库连接即可。

三、zyplayer-doc-manage

整合了上面两个功能到此项目,较少熟悉成本,git clone下来即可运行。

具有简单的权限管理、人员管理功能(还没想好具体怎么控制,没需求)。

使用最新的一些技术框架,很简单,初学者拿来学习也是很不错的。

界面展示:

权限和用户管理:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

数据库文档:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

增加文档处:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

使用springfox-swagger-ui访问增加的文档:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

文档展示:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

在线调试:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

模拟返回:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

文档配置:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

全局参数管理:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

下载地址:https://gitee.com/zyplayer/zyplayer-doc

3、database-doc-generator(数据库文档生成器:生成markdown文档)

database-doc-generator-数据库文档生成器。

该工具根据给定的链接生成数据库文档,如果你嫌powerdesigner太重,那么可以试试该工具。

你可以下载release包来或者下载源代码来使用。

如果使用源代码,需要先克隆该项目后运行mvn package打包,然后运行发布包中bin/start.bat。

运行程序后按照下面提示输入对应数据库参数:

input mysql host:

127.0.0.1

input mysql port:

3306

input database name:

guns-lite

input mysql username:

root

input mysql password:

root

输入完成后回车,即可生成数据库文档目录${dbname}-doc,目录中文档以markdown文件为载体:

10

确保安装了gitbook后,进入上述文件目录的命令行窗口运行:gitbook serve

E:\\database-doc-generator-20181006100721\guns-lite-doc>gitbook serve

openssl config failed: error:02001003:system library:fopen:No such process

Live reload server started on port: 35729

Press CTRL+C to quit ...

info: 7 plugins are installed

info: loading plugin "livereload"... OK

info: loading plugin "highlight"... OK

info: loading plugin "search"... OK

info: loading plugin "lunr"... OK

info: loading plugin "sharing"... OK

info: loading plugin "fontsettings"... OK

info: loading plugin "theme-default"... OK

info: found 15 pages

info: found 0 asset files

info: >> generation finished with success in 1.6s !

Starting server ...

Serving book on http://localhost:4000

访问 http://localhost:4000,即可在线查看数据库文档:

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

程序文档工具pandocGUI、zyplayer-doc、database-doc-generator介绍

下载地址:https://gitee.com/enilu/database-doc-generator

注明

以上就是程序文档工具pandocGUI、zyplayer-doc、database-doc-generator的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章