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

介紹

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來刪除。通常來說，這種狀況不會不少。