介绍showdoc是一款非常适合IT团队使用的在线API文档和技术文档工具。您可以使用Showdoc编写在线API文档、技术文档、数据字典和在线手册。showdoc的详细介绍见：https://www.showdoc.cc/help好的数据字典文档可以清晰的反映数据库的结构和相关定义，方便技术人员查阅。我们可以很方便的使用showdoc生成一个展示数据库结构的字典文档，并且可以根据数据库结构的变化自动修改文档，省去了手工编辑的麻烦。所有这些的自动化都依赖于我们的升级脚本。您需要下载我们的脚本在您的服务器上执行，并将数据库结构信息上传到showdoc。报告脚本的源代码完全公开，您可以阅读以确认安全。我们保证只会上传基本的数据库结构信息，不会上传数据库密码配置、业务数据等敏感信息。目前只支持linux下的mysql数据库，以后会考虑更多类型。操作步骤执行wget命令下载脚本https://www.showdoc.cc/script/showdoc_db.sh打开这个文件vishowdoc_db.sh修改配置信息打开文件后可以看到前面的几个配置文件。其中需要填写数据库配置、api_key等信息，填写完成后保存。下面列出了每个配置项的含义。host：数据库所在的地址。默认为localhostport：数据库访问端口，默认为3306user：数据库用户名password：密码db：要同步的数据库名称。要同步多个数据库，您可以复制此脚本的多个副本|api_key：身份验证凭据。登录showdoc，创建项目后，点击右上角“项目设置”-“打开API”，可以看到api_token:同上cat_name:optional。如果要将生成的文件放在项目的子目录下，这里填写子目录名。网址：可选。要同步到的url。如果您使用www.showdoc.cc，则无需更改此项。如果您部署的是开源版本的showdoc，请将其更改为http://xx.com/server/index.php?s=/api/open/updateDbItem。其中xx.com是你的部署域名|执行shshowdoc_db.sh，看到成功就ok了。可以打开showdoc项目看看是否真的生成了。如果要定时自动更新，需要在系统中添加定时任务。下面是一个例子，意思是/10****/bin/sh/root/showdoc_db.sh每10分钟同步一次。showdoc_db.sh脚本需要在定时任务中写入绝对路径。注意：如果设置了自动执行脚本，请不要手动登录showdoc修改文档。因为你的修改会被自动脚本重写。因为它会覆盖你的修改。所以如果要为某个字段设置中文注释，请修改mysql字段注释，不要在showdoc上手动编辑文档。在自动执行的情况下，只会自动添加新的和修改过的文件，不会自动删除文件（主要是出于数据安全的考虑）。因此，如果您删除一个表格，该页面不会在文档中被删除。需要手动登录showdoc删除。一般来说，这种情况不会很多。
