引見

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來刪除。平常來說，這類狀況不會許多。