如何利用showdoc自動生成數據字典

luckyw 發布于2019-06-28 18:47 / 2747人閱讀

摘要：關于的詳細介紹，可看好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義，方便技術人員查閱。自動執行的情況下，只會自動新增和修改文檔，不會自動刪除文檔主要出于數據安全考慮。

介紹

showdoc是一個非常適合IT團隊的在線API文檔、技術文檔工具。你可以使用Showdoc來編寫在線API文檔、技術文檔、數據字典、在線手冊。關于showdoc的詳細介紹，可看：https://www.showdoc.cc/help

好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義，方便技術人員查閱。我們很容易使用showdoc來生成展示數據庫結構的字典文檔，并且能根據數據庫結構的變動來自動修改文檔，省去人工編輯的麻煩。

這一切的自動化依賴于我們的上報腳本。你需要下載我們的腳本到你的服務器上執行，上傳數據庫結構信息到showdoc。上報腳本的源碼完全公開，你可以閱讀之以確認安全。我們確保它只會上傳基本數據庫結構信息，不會上傳數據庫密碼配置、業務數據等敏感信息。

目前只支持linux下的mysql數據庫，更多類型未來再考慮。

操作步驟

執行下載腳本的命令

wget https://www.showdoc.cc/script/showdoc_db.sh

打開此文件

vi showdoc_db.sh

修改配置信息
打開文件后，在文件的前面能看到幾項配置。其中，像數據庫配置、api_key等信息是需要你填寫的，填寫完畢后保存即可。下面列舉出各個配置項代表的意思。

 host ： 數據庫所在地址。默認是localhost  
 port  :  數據庫訪問端口，默認是3306 
 user  :  數據庫用戶名 
 password   :  密碼 
 db  :  要同步的數據庫名。要同步多個db可以將本腳本復制多份 |
 api_key   ： 認證憑證。登錄showdoc，創建一個項目后，點擊右上角的”項目設置”-“開放API”便可看到 
 api_token : 同上  
 cat_name: 可選。如果想把生成的文檔都放在項目的子目錄下，則這里填寫子目錄名。  
 url ：可選。 同步到的url。如果是使用www.showdoc.cc ，則不需要再改此項。如果是部署開源版showdoc，請改此項為http://xx.com/server/index.php?s=/api/open/updateDbItem 。其中xx.com為你的部署域名|

執行

sh showdoc_db.sh

看到成功字樣便ok。你可以打開showdoc項目看看是否真的生成了。

如果想定時自動更新，則需要為系統增加一個定時任務。下面給一個例子，表示每10分鐘同步一次

/10 * * * * /bin/sh /root/showdoc_db.sh

其中，showdoc_db.sh腳本在定時任務里需要寫絕對路徑。

注意事項

如果你設置了腳本的自動執行，那么請不要再手動登錄showdoc修改文檔。因為你的修改都會被自動腳本重新覆蓋。
因為會覆蓋你的修改。所以如果你想為某個字段設置中文注釋，請修改mysql字段注釋，而不是在showdoc上手動編輯文檔。
自動執行的情況下，只會自動新增和修改文檔，不會自動刪除文檔（主要出于數據安全考慮）。所以，如果你刪除了一張表，文檔里是不會刪除那個頁面的。需要手動登錄showdoc來刪除。一般來講，這種情況不會很多。

云服務器 GPU云服務器 idea生成數據字典如何利用大數據如何利用統計數據密碼字典生成器php

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/28660.html

如何利用showdoc自動生成數據字典

摘要：關于的詳細介紹，可看好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義，方便技術人員查閱。自動執行的情況下，只會自動新增和修改文檔，不會自動刪除文檔主要出于數據安全考慮。介紹 showdoc是一個非常適合IT團隊的在線API文檔、技術文檔工具。你可以使用Showdoc來編寫在線API文檔、技術文檔、數據字典、在線手冊。關于showdoc的詳細介紹，可看：https://www....

lookSomeone 2019-08-22 16:39 評論0 收藏0
如何利用showdoc自動生成數據字典

摘要：關于的詳細介紹，可看好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義，方便技術人員查閱。自動執行的情況下，只會自動新增和修改文檔，不會自動刪除文檔主要出于數據安全考慮。介紹 showdoc是一個非常適合IT團隊的在線API文檔、技術文檔工具。你可以使用Showdoc來編寫在線API文檔、技術文檔、數據字典、在線手冊。關于showdoc的詳細介紹，可看：https://www....

banana_pi 2019-06-25 18:37 評論0 收藏0
showDoc 文檔管理系統支持markdown

摘要：用可以非常方便快速地編寫出美觀的文檔。同時也可以將項目導出成文件，以便離線瀏覽。權限管理公開項目與私密項目上的項目有公開項目和私密項目兩種。項目成員你可以很方便地為的項目添加刪除項目成員。下載地址：https://github.com/star7th/sh... ShowDoc是什么每當接手一個他人開發好的模塊或者項目，看著那些沒有寫注釋的代碼，我們都無比抓狂。文檔呢？！文檔呢？！...

lingdududu 2019-06-27 16:29 評論0 收藏0
在線文檔分享工具ShowDoc

摘要：就是一個非常適合團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率。部署到自己的服務器部署手冊請參考使用在線的如果你沒有自己的服務器，但又想使用作為分檔分享工具，你可以使用在線的版權遵循開源協議發布，并提供免費使用。 ShowDoc是什么每當接手一個他人開發好的模塊或者項目，看著那些沒有寫注釋的代碼，我們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ！！程序...

JeOam 2019-06-27 11:46 評論0 收藏0